must 0.2.1

data/README

@@ -0,0 +1,132 @@
+Must
+====
+
+add Object#must method to constrain its origin and conversions
+
+  # can write like this
+    num = params[:num].to_i.must.match(1..300) {10}
+
+  # rather than
+    num = params[:num].to_i
+    num = 10 unless (1..300) === num
+
+
+Testing Methods
+===============
+
+be      : check whether object equals to the argument
+kind_of : check whether object is a kind of the argument
+coerced : check whether object can be coerced to the argument
+blank   : check whether object is blank?
+exist   : check whether object is not nil (NOTE: false is ok)
+
+
+Logical Methods
+===============
+
+not : logical NOT
+
+
+Nop Methods
+===========
+
+a  : return self
+an : return self
+
+These effect nothing but exist only for English grammar.
+
+
+Basic Examples
+==============
+
+# test its value exactly
+1.must.be 1              # => 1
+[1,2,3].must.be [1,2,3]  # => [1,2,3]
+
+# exceptions
+1.must.be []             # Must::Invalid exception
+1.must.be([]) {:ng}      # => :ng
+1.must.be(1) {:ng}       # => 1
+
+# as default value
+name = params[:name].must.not.be.blank{ "No name" }
+
+# existing test
+1.must.exist             # => 1
+nil.must.exist           # Must::Invalid exception
+false.must.exist         # => false
+
+# test class : ensures that a class of the object is one of given arguments
+1.must.be.kind_of(Integer)         # => 1
+1.must.be.kind_of(Integer, Array)  # => 1
+[].must.be.kind_of(Integer, Array) # => []
+1.must.be.kind_of(String, Array)   # Must::Invalid: expected String/Array but got Fixnum
+
+# coercing : looks like kind_of except converting its value if possible
+1.must.be.coerced(Integer, String => proc{|val| val.to_i})    # => 1
+"1".must.be.coerced(Integer, String => proc{|val| val.to_i})  # => 1
+"1".must.be.coerced(Integer, String => :to_i)                 # => 1     (NOTE: inline Symbol means sending the method)
+"1".must.be.coerced(Integer, Symbol, String => proc{:to_i})   # => :to_i (NOTE: use proc to return Symbol itself)
+
+
+Actual Examples
+===============
+
+1)
+
+  normal code:
+
+    def set_reader(reader)
+      if reader.is_a?(CSV::Reader)
+        @reader = reader
+      elsif file.is_a?(String)
+        @reader = CSV::Reader.create(i)
+      elsif file.is_a?(Pathname)
+        @reader = CSV::Reader.create(reader.read)
+      else
+        raise 'invalid reader'
+      end
+    end
+
+  refactor above code with must plugin
+ 
+    def set_reader(reader)
+      @reader = reader.must.be.coerced(CSV::Reader, Pathname=>:read, String=>{|i| CSV::Reader.create(i)}) {raise 'invalid reader'}
+    end
+
+2)
+
+  class DateFolder
+    def initialize(date)
+      @date = date.must.be.coerced(Date, String=>proc{|i| Date.new(*i.scan(/\d+/).map{|i|i.to_i})})
+    end
+  end
+
+  # this can accept both formats
+
+  DateFolder.new Date.today
+  DateFolder.new "2008-12-9"
+
+
+Install
+=======
+
+gem install maiha-must
+# add source http://gems.github.com
+
+% irb -r rubygems -r must
+irb(main):001:0> 1.must.be 1
+=> 1
+
+
+Github
+======
+
+http://github.com/maiha/must
+
+
+Author
+======
+
+maiha@wota.jp
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+GEM_NAME = "must"
+AUTHOR = "maiha"
+EMAIL = "maiha@wota.jp"
+HOMEPAGE = "http://github.com/maiha/must"
+SUMMARY = "constraint plugin"
+GEM_VERSION = "0.2.1"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'asakusarb'
+  s.executables = []
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.files = %w(README Rakefile) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+

data/lib/must/rule.rb

@@ -0,0 +1,86 @@
+require 'set'
+
+module Must
+  class Rule
+    attr_reader :object
+
+    def initialize(object)
+      @object    = object
+      @not       = false
+    end
+
+    def a()  self end
+    def an() self end
+
+    def not
+      @not = ! @not
+      return self
+    end
+
+    def be(*args, &block)
+      if args.empty?
+        self
+      else
+        valid?(object == args.shift, &block)
+      end
+    end
+
+    def empty(&block)
+      valid?(object.empty?, &block)
+    end
+
+    def blank(&block)
+      valid?(object.blank?, &block)
+    end
+
+    def exist(&block)
+      self.not()
+      be(nil, &block)
+    end
+
+    def kind_of(*targets)
+      valid?(targets.any?{|klass| object.is_a? klass}) {
+        target = targets.map{|i| i.name}.join('/')
+        raise Invalid, "expected #{target} but got #{object.class}"
+      }
+    end
+
+    def one_of(target, &block)
+      valid?(target === @object, &block)
+    end
+
+    def valid?(condition, &block)
+      if condition ^ @not
+        object
+      else
+        block_or_throw(&block)
+      end
+    end
+
+    def block_or_throw(&block)
+      if block
+        block.call
+      else
+        raise Invalid
+      end
+    end
+
+    def coerced(*types, &block)
+      coecings        ||= types.last.is_a?(Hash) ? types.pop : {}
+      already_coerced ||= Set.new
+      kind_of(*types)
+    rescue Invalid
+      block_or_throw(&block) if already_coerced.include?(@object.class)
+      already_coerced << @object.class
+      @object =
+        case (obj = coecings[@object.class])
+        when Symbol ; @object.send obj
+        when Proc   ; obj.call(@object)
+        else        ; obj
+        end
+      retry
+    end
+
+    alias :match :one_of
+  end
+end

data/lib/must.rb

@@ -0,0 +1,12 @@
+# Must
+module Must
+  class Invalid < StandardError; end
+  class ShouldNotEmpty  < Invalid; end
+
+  def must
+    Rule.new(self)
+  end
+end
+
+require File.dirname(__FILE__) + '/must/rule'
+Object.__send__ :include, Must

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: must
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- maiha
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-07 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: constraint plugin
+email: maiha@wota.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- lib/must/rule.rb
+- lib/must.rb
+has_rdoc: true
+homepage: http://github.com/maiha/must
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: asakusarb
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: constraint plugin
+test_files: []
+