checkthelist 0.0.0

data/lib/checklist/checklist.rb

@@ -0,0 +1,33 @@
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Checklist
+
+  def checklist
+    self.class.get_checklist(self)
+  end
+
+  module ClassMethods
+
+    # entry point
+    def checklist(&block)
+      @checklist ||= List.new self
+      @checklist.update(&block) if block_given?
+      @checklist
+    end
+
+    def get_checklist(context = nil)
+      @checklist.context = context
+      @checklist
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end

data/lib/checklist/exceptions.rb

@@ -0,0 +1,12 @@
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Checklist
+  class InstanceMissingError < StandardError
+  end
+end

data/lib/checklist/item.rb

@@ -0,0 +1,25 @@
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Checklist
+  class Item
+    attr_reader :explain, :key, :list
+
+    def initialize(explain, list = nil, &block)
+      @list = list
+      @block = block
+      @explain = explain
+    end
+
+    def checked?
+      raise Checklist::InstanceMissingError unless list.context
+      list.context.instance_eval(&@block) == true
+    end
+
+  end
+end

data/lib/checklist/list.rb

@@ -0,0 +1,71 @@
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'forwardable'
+
+module Checklist
+  class List
+    extend ::Forwardable
+
+    def_delegators :@list, :each, :map, :select, :first, :last
+
+    attr_reader :items, :context
+
+    def initialize(klass, &block)
+      @klass, @items = klass, []
+      update(&block)
+    end
+
+    def update(&block)
+      instance_eval(&block) if block_given?
+      self
+    end
+
+    # return true if all items are validated
+    def valid?
+      items.each do |item|
+        return false unless item.checked?
+      end
+      return true
+    end
+
+    def context= (instance)
+      @context = instance
+    end
+
+    # = Example
+    # each_checked do |explain, checked|
+    #   puts "#{explain} = #{checked}"
+    # end
+    def each_checked(&block)
+      items.each do |item|
+        block.call(item.explain, item.checked?)
+      end
+    end
+
+    def map_checked(&block)
+      if block_given?
+        items.map {|item| block.call(item.explain, item.checked?) }
+      else
+        items.map {|item| [item.explain, item.checked?] }
+      end
+    end
+
+    def errors
+      items.select { |item| !item.checked? }
+    end
+
+    private
+
+    def it(explain, &block)
+      @items << Item.new(explain, self, &block)
+    end
+
+  end
+end

data/lib/checklist.rb

@@ -0,0 +1,16 @@
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Checklist
+  %w(
+    checklist
+    item
+    list
+    exceptions
+  ).each { |file| require File.join(File.dirname(__FILE__), 'checklist', file) }
+end

data/spec/checklist_spec.rb

@@ -0,0 +1,117 @@
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative '../lib/checklist'
+
+class TestingChecklist
+  include Checklist
+
+  attr_accessor :world
+
+  def initialize
+    @world = "World"
+    @true = true
+  end
+
+  checklist do
+    it "World should contains the world string" do
+      world == "World"
+    end
+    it "the truth" do
+      @true == true
+    end
+  end
+end
+
+# verify if there is no collapsing in the rules
+class TestingChecklist2
+  include Checklist
+
+  attr_accessor :world
+
+  def initialize
+    @world = "Monde"
+  end
+
+  checklist do
+    it "World should contains the world string" do
+      world == "Monde"
+    end
+  end
+end
+
+
+describe Checklist do
+
+  let(:instance){ TestingChecklist.new }
+  let(:instance2){ TestingChecklist2.new }
+  let(:invalid){ a = TestingChecklist.new; a.world = "Blabla"; a }
+
+  describe 'checklist' do
+    it 'should return an array of ChecklistItem' do
+      instance.checklist.items.first.should be_a(Checklist::Item)
+    end
+
+    it 'should not share items between classes' do
+      instance.checklist.items.size.should == 2
+      instance2.checklist.items.size.should == 1
+    end
+  end
+
+  describe 'valid?' do
+    context 'when calling from instance' do
+      it 'should return true if all conditions return true' do
+        instance.checklist.should be_valid
+        instance2.checklist.should be_valid
+      end
+      it 'should return false if one fails' do
+        invalid.checklist.should_not be_valid
+      end
+
+    end
+
+    context 'when calling from class' do
+      it 'should raise an exception' do
+        lambda do
+          TestingChecklist.get_checklist.valid?
+        end.should raise_exception Checklist::InstanceMissingError
+      end
+    end
+  end
+
+  describe 'each_checked' do
+    it 'should iterate and give the block the message and the true/false value' do
+      instance.checklist.each_checked do |explain, checked|
+        explain.should be_a(String)
+        checked.should be
+      end
+    end
+  end
+
+  describe 'map_checked' do
+    context 'without block' do
+      it 'should return an array of array' do
+        invalid.checklist.map_checked.should == [
+          ["World should contains the world string", false],
+          ["the truth", true],
+        ]
+      end
+    end
+    context 'with block' do
+      it 'should work as the regular map but give the message and the true/false' do
+        invalid.checklist.map_checked do |sms, checked|
+          [checked, sms]
+        end.should == [
+          [false, "World should contains the world string"],
+          [true, "the truth"]
+        ]
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: checkthelist
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Diego d'Ursel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 00:00:00.000000000 Z
+dependencies: []
+description: Lets you create your list of rules and see them checked once the provided
+  block return true
+email: diegodurs@gmail/com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/checklist.rb
+- lib/checklist/checklist.rb
+- lib/checklist/exceptions.rb
+- lib/checklist/item.rb
+- lib/checklist/list.rb
+- spec/checklist_spec.rb
+homepage: http://rubygems.org/gems/checkmylist
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Checklist helper
+test_files: []