NeuronCheck

プラグイン一覧

• パーマリンク

  

  現在、RubyGemsを通じて配布中の公式プラグインの一覧です。
  gemをインストールしてから、requireで読み込むことで、新しいキーワードが使えるようになります。

  • neuroncheck-not_empty
  • neuroncheck-present
  • neuroncheck-boolean

  neuroncheck-not_empty

  「not_empty」キーワードと、そのエイリアスである「non_empty」「nonempty」を追加。empty?メソッドを使用することで、引数が「空でない値であるかどうか」をチェックします。

  % gem install neuroncheck-not_empty
  

  require 'neuroncheck/plugin/not_empty'
  
  class Converter
    extend NeuronCheck
  
    ndecl {
      args not_empty(String) # empty?を使って、引数が「空でない文字列」であるかどうかをチェック。
                             # 文字列でない値や、'' (空文字列) が渡された場合エラーとなる
    }
    def convert_file(file_path)
    end
  end
  

  args not_empty(Array) #=> 空でない配列であることをチェック
  args not_empty(Hash)  #=> 空でないHashであることをチェック
  args not_empty(array_of(String)) #=> 文字列のみで構成された、空でない配列であることをチェック
  
  # not_empty(String) の別記法
  args nonempty(String)
  args non_empty(String)
  

  neuroncheck-present

  「present」キーワードを追加。ActiveSupportのpresent?メソッドを使用し、引数が「空でない値であるかどうか」をチェックします。

  % gem install neuroncheck-present
  

  require 'neuroncheck/plugin/present'
  
  class Converter
    extend NeuronCheck
  
    ndecl {
      args present(String) #=> ActiveSupportのpresent?を使って、引数が「空でない文字列」であるかどうかをチェック。 '' や ' ' (空白) などはエラーとなる
    }
    def convert_file(file_path)
    end
  end
  

  args present(Array) #=> 空でない配列であることをチェック
  args present(Hash)  #=> 空でないHashであることをチェック
  
  

  「blank」キーワードは、presentと比べるとNeuronCheckでの使用機会がほぼないように思われたため、追加していません。

  neuroncheck-boolean

  「boolean」キーワードを追加。trueかfalseのどちらかの値だけを受け付けます。

  % gem install neuroncheck-boolean
  

  require 'neuroncheck/plugin/boolean'
  
  class Document
    extend NeuronCheck
  
    ndecl {
      returns boolean #=> [true, false]を指定した場合と同じ意味
    }
    def loaded?
    end
  end