checkthelist 0.0.1 → 0.0.3

data/lib/checklist/item.rb

@@ -8,9 +8,10 @@
 
 module Checklist
   class Item
-    attr_reader :explain, :key, :list
+    attr_reader :explain, :key, :list, :options
 
-    def initialize(explain, list = nil, &block)
+    def initialize(explain, list = nil, options = {}, &block)
+      @options = options
       @list = list
       @block = block
       @explain = explain
@@ -18,7 +19,44 @@ module Checklist
 
     def checked?
       raise Checklist::InstanceMissingError unless list.context
-      list.context.instance_eval(&@block) == true
+      context.instance_eval(&@block) == true
+    end
+
+    # return true if the item should be checked
+    def keep?
+      keep = only_applies?
+      keep = except_applies? if keep.nil?
+      keep
+    end
+
+    private
+
+    def context
+      list.context
+    end
+
+    # based on options[:except], the method ...
+    #  return false if item should not be checked
+    #  return true if the item should be checked
+    #  return nil if option was not supplied
+    def except_applies?
+      options[:except].nil? ? nil : !exec(options[:except])
+    end
+
+    # based on options[:only], the method ...
+    #  return false if item should not be checked
+    #  return true if the item should be checked
+    #  return nil if option was not supplied
+    def only_applies?
+      options[:only].nil? ? nil : exec(options[:only])
+    end
+
+    def exec(sym_or_proc)
+      if sym_or_proc.is_a?(Symbol)
+        context.send(sym_or_proc)
+      elsif sym_or_proc.is_a?(Proc)
+        context.instance_eval(&sym_or_proc)
+      end
     end
 
   end

data/lib/checklist/list.rb

@@ -43,28 +43,44 @@ module Checklist
     # each_checked do |explain, checked|
     #   puts "#{explain} = #{checked}"
     # end
-    def each_checked(&block)
-      items.each do |item|
+    def each_checked(options = {}, &block)
+      options = parse_options(options)
+      get_items(options).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
+    def map_checked(options = {}, &block)
+      options = parse_options(options)
+      block ||= lambda { |msg, checked| [msg, checked] }
+      items.map {|item| block.call(item.explain, item.checked?) }
     end
 
     def errors
       items.select { |item| !item.checked? }
     end
 
+    # items that should be checked
+    def filtered_items
+      items.select { |item| item.keep? }
+    end
+
     private
 
-    def check(explain, &block)
-      @items << Item.new(explain, self, &block)
+    def check(explain, item_options = {}, &block)
+      @items << Item.new(explain, self, item_options, &block)
+    end
+
+    def get_items(options)
+      options[:filtered] ? filtered_items : items
+    end
+
+    def default_options
+      { filtered: true }
+    end
+
+    def parse_options(options = {})
+      default_options.merge(options)
     end
 
   end

data/spec/checklist_spec.rb

@@ -7,26 +7,7 @@
 # THE SOFTWARE.
 
 require_relative '../lib/checklist'
-
-class TestingChecklist
-  include Checklist
-
-  attr_accessor :world
-
-  def initialize
-    @world = "World"
-    @true = true
-  end
-
-  checklist do
-    check "World should contains the world string" do
-      world == "World"
-    end
-    check "the truth" do
-      @true == true
-    end
-  end
-end
+require_relative 'testing_checklist'
 
 # verify if there is no collapsing in the rules
 class TestingChecklist2
@@ -63,6 +44,34 @@ describe Checklist do
     end
   end
 
+  describe 'filtered_items' do
+    context 'when only is set to true' do
+      it 'should return the item' do
+        instance.only = true
+        instance.checklist.filtered_items.map{|i| i.explain}.should include("the truth")
+      end
+    end
+
+    context 'when only is set to false' do
+      it 'should not return the item' do
+        instance.only = false
+        instance.checklist.filtered_items.map{|i| i.explain}.should_not include("the truth")
+      end
+    end
+    context 'when except is set to true' do
+      it 'should not return the item' do
+        instance.except = true
+        instance.checklist.filtered_items.map{|i| i.explain}.should_not include("World should contains the world string")
+      end
+    end
+    context 'when except is set to false' do
+      it 'should return the item' do
+        instance.except = false
+        instance.checklist.filtered_items.map{|i| i.explain}.should include("World should contains the world string")
+      end
+    end
+  end
+
   describe 'valid?' do
     context 'when calling from instance' do
       it 'should return true if all conditions return true' do

data/spec/testing_checklist.rb

@@ -0,0 +1,23 @@
+require_relative '../lib/checklist'
+
+class TestingChecklist
+  include Checklist
+
+  attr_accessor :world, :only, :except
+
+  def initialize
+    @world = "World"
+    @true = true
+    @only = false
+    @except = false
+  end
+
+  checklist do
+    check "World should contains the world string", except: :except do
+      world == "World"
+    end
+    check "the truth", only: :only do
+      @true == true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkthelist
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -18,13 +18,14 @@ 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
+- lib/checklist.rb
 - spec/checklist_spec.rb
-homepage: http://rubygems.org/gems/checkmylist
+- spec/testing_checklist.rb
+homepage: http://rubygems.org/gems/checkthelist
 licenses:
 - MIT
 post_install_message: