ccp 0.2.7 → 0.2.8

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+tmp/*

data/README.rdoc

@@ -116,6 +116,24 @@ This profile option prints benchmarks of commands.
   ...
 
 
+== Skip commands
+
+"skip" prefixed data key names are reserved for command skipping feature.
+When data[:skip_XXX] given, the XXX command won't be invoked.
+
+  class Program
+    include Ccp::Commands::Composite
+    command Cmd1
+    command Cmd2
+  end
+
+  # normal case
+  Program.execute                       # => Both Cmd1 and Cmd2 will be called
+
+  # with skip
+  Program.execute(:skip_cmd1 => true)   # => Both Cmd2 will be called
+
+
 == Fixtures
 
 Let's imagine a following command that just read :a and write :x.

data/lib/ccp/receivers.rb

@@ -7,6 +7,7 @@ module Ccp
     autoload :Variables      , 'ccp/receivers/variables'
     autoload :Executable     , 'ccp/receivers/executable'
     autoload :Aroundable     , 'ccp/receivers/aroundable'
+    autoload :Skippable      , 'ccp/receivers/skippable'
     autoload :Commentable    , 'ccp/receivers/commentable'
     autoload :Profileable    , 'ccp/receivers/profileable'
     autoload :Fixtures       , 'ccp/receivers/fixtures'

data/lib/ccp/receivers/base.rb

@@ -10,6 +10,7 @@ module Ccp
       include Executable
       include Profileable
       include Aroundable
+      include Skippable
       include Fixtures
 
       # ensure to call '#setup' for module initializations

data/lib/ccp/receivers/fixtures.rb

@@ -84,13 +84,7 @@ module Ccp
       end
 
       def default_fixture_fail(cmd, key, exp, got)
-        if exp == nil and got == nil
-          raise Failed, "#{cmd.class} should write #{key} but not found"
-        end
-
-        exp_info = "%s(%s)" % [exp.inspect.truncate(200), Must::StructInfo.new(exp).compact.inspect]
-        got_info = "%s(%s)" % [got.inspect.truncate(200), Must::StructInfo.new(got).compact.inspect]
-        raise Failed, "%s should create %s for %s, but got %s" % [cmd.class, exp_info, key, got_info]
+        Ccp::Utils::TestFailed::PROC.call(cmd, key, exp, got)
       end
 
       def fixture_save?(cmd)

data/lib/ccp/receivers/skippable.rb

@@ -0,0 +1,16 @@
+module Ccp
+  module Receivers
+    module Skippable
+      def execute(cmd)
+        return false if skip?(cmd)
+        super
+      end
+
+      private
+        def skip?(cmd)
+          key = "skip_%s" % cmd.class.name.underscore.gsub("/","_")
+          data.set?(key)
+        end
+    end
+  end
+end

data/lib/ccp/utils.rb

@@ -3,5 +3,6 @@ module Ccp
     autoload :Data           , 'ccp/utils/data'
     autoload :Colorize       , 'ccp/utils/colorize'
     autoload :Options        , 'ccp/utils/options'
+    autoload :TestFailed     , 'ccp/utils/test_failed'
   end
 end

data/lib/ccp/utils/test_failed.rb

@@ -0,0 +1,46 @@
+module Ccp
+  module Utils
+    module TestFailed
+      Differ = Struct.new(:a, :b, :path)
+      class Differ
+        def execute
+          unless a.class == b.class
+            failed("%s expected [%s], but got [%s]" % [path, a.class, b.class])
+          end
+
+          if a.class == Array
+            max = [a.size, b.size].max
+            (0...max).each do |i|
+              Differ.new(a[i], b[i], "#{path}[#{i}]").execute
+            end
+            return true
+          end
+
+          if a.class == Hash
+            (a.keys | b.keys).each do |key|
+              Differ.new(a[key], b[key], "#{path}[#{key}]").execute
+            end
+            return true
+          end
+
+          unless a == b
+            failed("%s expected %s, but got %s" % [path, a.inspect, b.inspect])
+          end
+        end
+
+        private
+          def failed(msg)
+            raise Ccp::Failed, msg
+          end
+      end
+
+      PROC = proc {|cmd, key, exp, got|
+        if exp == nil and got == nil
+          raise Ccp::Failed, "#{cmd.class} should write #{key} but not found"
+        end
+        TestFailed::Differ.new(exp, got, key).execute
+        raise Ccp::Failed, "[FATAL] %s expected %s, but got %s" % [cmd.class, exp_type.inspect, got_type.inspect]
+      }
+    end
+  end
+end

data/lib/ccp/version.rb

@@ -1,3 +1,3 @@
 module Ccp
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/spec/receivers/fixture_stub_spec.rb

@@ -39,7 +39,7 @@ describe Ccp::Receivers::Fixtures do
     it "should raise when current data doesn't match the given data" do
       lambda {
         Cmd1StubInvalidMock.execute
-      }.should raise_error(/should create/)
+      }.should raise_error(/breadcrumbs.*expected.*got.*String/)
     end
   end
 

data/spec/receivers/skippable_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+describe Ccp::Receivers::Skippable do
+  let(:options) { {:breadcrumbs => []} }
+  let(:program) { Program }
+  let(:data)    { program.execute(options).data }
+
+  def breadcrumbs
+    data[:breadcrumbs]
+  end
+
+  describe "#execute" do
+    context "(standard case)" do
+      it "should execute normally" do
+        breadcrumbs.should == ["Program#before", "Cmd1#before", "Cmd1#execute", "Cmd1#after", "Cmd2#before", "Cmd2#execute", "Cmd2#after", "Cmd3#before", "Cmd3#execute", "Cmd3#after", "Program#after"]
+      end
+    end
+
+    context "(:skip_cmd1 given)" do
+      before { options[:skip_cmd1] = true }
+      it "should execute without Cmd1" do
+        breadcrumbs.should == ["Program#before", "Cmd2#before", "Cmd2#execute", "Cmd2#after", "Cmd3#before", "Cmd3#execute", "Cmd3#after", "Program#after"]
+      end
+    end
+
+    context "(:skip_cmd1, :skip_cmd3 given)" do
+      before { options[:skip_cmd1] = true; options[:skip_cmd3] = true }
+      it "should execute without Cmd1 and Cmd3" do
+        breadcrumbs.should == ["Program#before", "Cmd2#before", "Cmd2#execute", "Cmd2#after", "Program#after"]
+      end
+    end
+
+    context "(:skip_program(top level cmd) given)" do
+      before { options[:skip_program] = true }
+      it "should execute nothing" do
+        breadcrumbs.should == []
+      end
+    end
+
+    context "(non-matched skip key given)" do
+      before { options[:skip_XXX] = true }
+      it "should execute normally" do
+        breadcrumbs.should == ["Program#before", "Cmd1#before", "Cmd1#execute", "Cmd1#after", "Cmd2#before", "Cmd2#execute", "Cmd2#after", "Cmd3#before", "Cmd3#execute", "Cmd3#after", "Program#after"]
+      end
+    end
+  end
+
+  context "[moduled cmd]" do
+    let(:program) { ::SkippableTest::Program }
+
+    module ::SkippableTest
+      class CmdX < Cmd1
+        include Breadcrumbing
+      end
+
+      class Program
+        include Ccp::Commands::Composite
+        command CmdX
+        command Cmd1
+      end
+    end
+
+    context "(standard case)" do
+      it "should execute normally" do
+        breadcrumbs.should == ["SkippableTest::CmdX#before", "SkippableTest::CmdX#execute", "SkippableTest::CmdX#after", "Cmd1#before", "Cmd1#execute", "Cmd1#after"]
+      end
+    end
+
+    context "(:skip_cmd1 given)" do
+      before { options[:skip_cmd1] = true }
+      it "should execute without Cmd1" do
+        breadcrumbs.should == ["SkippableTest::CmdX#before", "SkippableTest::CmdX#execute", "SkippableTest::CmdX#after"]
+      end
+    end
+
+    context "(:skip_skippable_test_cmd_x given)" do
+      before { options[:skip_skippable_test_cmd_x] = true }
+      it "should execute without Skippable::CmdX" do
+        breadcrumbs.should == ["Cmd1#before", "Cmd1#execute", "Cmd1#after"]
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ccp
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 0
   - 2
-  - 7
-  version: 0.2.7
+  - 8
+  version: 0.2.8
 platform: ruby
 authors: 
 - maiha
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-22 00:00:00 +09:00
-default_executable: 
+date: 2013-02-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: typed
@@ -130,6 +129,7 @@ files:
 - lib/ccp/receivers/none.rb
 - lib/ccp/receivers/profileable.rb
 - lib/ccp/receivers/settings.rb
+- lib/ccp/receivers/skippable.rb
 - lib/ccp/receivers/variables.rb
 - lib/ccp/serializers.rb
 - lib/ccp/serializers/core.rb
@@ -139,6 +139,7 @@ files:
 - lib/ccp/utils/colorize.rb
 - lib/ccp/utils/fixture_options.rb
 - lib/ccp/utils/options.rb
+- lib/ccp/utils/test_failed.rb
 - lib/ccp/version.rb
 - spec/commands/base_spec.rb
 - spec/commands/composite_spec.rb
@@ -167,12 +168,12 @@ files:
 - spec/receivers/fixture_save_where_spec.rb
 - spec/receivers/fixture_save_why_spec.rb
 - spec/receivers/fixture_stub_spec.rb
+- spec/receivers/skippable_spec.rb
 - spec/serializers/core_spec.rb
 - spec/serializers/json_spec.rb
 - spec/serializers/spec.rb
 - spec/serializers/yaml_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/maiha/ccp
 licenses: []
 
@@ -202,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ccp
-rubygems_version: 1.3.7
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A Ruby library for Composite Command Programming