french_man 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,39 @@
+# French Man
+
+Hash and object mocking
+
+## Basic Example
+
+``` ruby
+groceries = FrenchMan::Grocery.blueprint {
+  garlic { true }
+}
+
+groceries.garlic #=> true
+groceries[:garlic] #=> true
+```
+
+## Bigger Example
+
+``` ruby
+groceries = FrenchMan::Grocery.plan {
+  vino {
+    FrenchMan::Vino.plan {
+      red { "Syrah" }
+      white { "Cabernet Sauvignon" }
+    }
+  }
+  cheeses {
+    ['Camembert', 'Crotin du Chavignol']
+  }
+}
+
+groceries.vino.red #=> "Syrah"
+```
+
+## Hash Example
+```ruby
+groceries = FrenchMan::Grocery.plan :vino => { :red => "Syrah", :white => "Cabernet Sauvignon"}
+
+groceries.vino.red #=> "Syrah"
+```

data/french_man.gemspec

@@ -14,6 +14,9 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "french_man"
  
   s.add_development_dependency "rspec", "2.5.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "ruby-debug"
+  s.add_development_dependency "json"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/french_man.rb

@@ -17,7 +17,7 @@
 #   login.password
 #   => 'baguette'
 class FrenchMan
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
   def self.const_missing(name) #:nodoc:
     clazz = Class.new do
@@ -26,19 +26,39 @@ class FrenchMan
         send(:class_variable_set, :@@blueprint, blueprint)
       end
 
-      def self.plan(&block)
+      def self.plan(hash = nil, &block)
         blueprint = send(:class_variable_get, :@@blueprint)
         raise "blueprint is missing" if blueprint.nil?
-        plan = Plan.new &block
+        plan = hash.nil? ? Plan.new(&block) : HashBuild.new(hash)
         blueprint.merge plan.hash
       end
     end
     self.const_set name, clazz
   end
   
+  class HashBuild
+    def initialize(hash)
+      @hash = hash || {}
+    end
+
+    def hash
+      result = {}
+      @hash.each_pair do |key, value|
+        key_string = key.to_s.capitalize
+        if FrenchMan.const_defined? key_string
+          blueprint = FrenchMan.const_get key_string
+          result.merge! key => blueprint.plan(value)
+        else
+          result.merge! key => value
+        end
+      end
+      ObjectifiedHash.new result
+    end
+  end
+
   # Creates a new plan hash for merging with a blueprint
   class Plan
-    undef_method :id
+    undef_method :id if method_defined?(:id)
 
     attr_reader :hash
 
@@ -54,7 +74,8 @@ class FrenchMan
 
   # The blueprint to create hashes from
   class Blueprint
-    undef_method :id, :type
+    undef_method :id if method_defined?(:id)
+    undef_method :type if method_defined?(:type)
 
     def initialize(&block) #:nodoc:
       @hash = {}
@@ -77,17 +98,33 @@ class FrenchMan
     end
   end
   
-  # Wraper for plan hashes so dot syntax can be used
   class ObjectifiedHash
-    undef_method :==, :===, :=~, :id
+    undef_method :id if method_defined?(:id)
+    undef_method :==, :===, :=~
 
     def initialize(attributes = {}) #:nodoc:
       @attributes = attributes
     end
 
+    def to_hash
+      hash = {}
+      @attributes.each do |key, val|
+        if val.is_a? Array
+          hash[key] = val.map { |elmt| (elmt.respond_to? 'to_hash') ? elmt.to_hash : elmt }
+        else
+          hash[key] = (val.respond_to? 'to_hash') ? val.to_hash : val
+        end
+      end
+      hash
+    end
+
+    def to_json(options={}) # by default Object.to_json return 'attributes' root key
+      to_hash.to_json(options)
+    end
+
     def method_missing(name, *args) #:nodoc:
       if @attributes.has_key? name
-        value = @attributes[name]
+        value = name.is_a?(Hash) ? self.class.new(@attributes[name]) : @attributes[name]
       else
         @attributes.send name, *args
       end

data/spec/french_man_spec.rb

@@ -50,28 +50,49 @@ describe FrenchMan do
     }
   end
 
-  it "should build a hash using a dsl" do
-    build = FrenchMan::Login.plan {
-      groceries {
-        FrenchMan::Grocery.plan {
-          vino { FrenchMan::Vino.plan }
-          other_items {
-            [
-              FrenchMan::OtherItem.plan,
-              FrenchMan::OtherItem.plan {
-                name { 'two' }
-                num { 2 }
-              }
-            ]
+  describe "working with a few level of nesting" do
+    
+    let(:build) {
+      FrenchMan::Login.plan {
+        groceries {
+          FrenchMan::Grocery.plan {
+            vino { FrenchMan::Vino.plan }
+            other_items {
+              [
+                FrenchMan::OtherItem.plan,
+                FrenchMan::OtherItem.plan {
+                  name { 'two' }
+                  num { 2 }
+                }
+              ]
+            }
           }
         }
       }
     }
-    build.should == resulting_blueprint
+
+    it "should build a hash using a dsl" do
+      build.should == resulting_blueprint
+    end
+
+    it "should be able to return a proper hash (without showing the 'attributes' root element)" do
+      build.to_hash.should == resulting_blueprint
+    end
+
+    it "should be able to produce the same json as a standard hash (if available)" do
+      require 'json'
+      build.to_json.should == resulting_blueprint.to_json
+    end
+
   end
 
-  it "should return objectified hash objects" do
-    build = FrenchMan::Login.plan {
+  it "should handle type in object" do
+    test_type = FrenchMan::TestType.plan
+    test_type[:type].should == 'test'
+  end
+
+  let(:shopping) {
+    FrenchMan::Login.plan {
       groceries {
         FrenchMan::Grocery.plan {
           vino {
@@ -86,12 +107,27 @@ describe FrenchMan do
         }
       }
     }
-    build.groceries.vino.red.should == "Syrah"
-    build.groceries.cheeses.should == ['Camembert', 'Crotin du Chavignol']
+  }
+
+  it "should return objectified hash objects" do
+    shopping.groceries.vino.red.should == "Syrah"
+    shopping[:groceries][:vino][:red].should == "Syrah"
   end
 
-  it "should handle type in object" do
+  it "should return objectified hash objects" do
+    shopping.groceries.cheeses.should == ['Camembert', 'Crotin du Chavignol']
+    shopping[:groceries][:cheeses].should == ['Camembert', 'Crotin du Chavignol']
+  end
+
+  it "should be able to use hash syntax for plan" do
+    hash = FrenchMan::Login.plan :grocery => { :vino => { :red => "Syrah", :white => "Cabernet Sauvignon"} }
+    hash.grocery.vino.red.should == "Syrah"
+    hash[:grocery][:vino][:red].should == "Syrah"
+  end
+  
+  it "should handle type in object for <= ruby 1.8.7" do
     test_type = FrenchMan::TestType.plan
     test_type[:type].should == 'test'
   end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: french_man
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Rufus Post
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-16 00:00:00 +10:00
-default_executable: 
+date: 2012-10-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -35,6 +34,48 @@ dependencies:
         version: 2.5.0
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: 
 email: 
 - rufuspost@gmail.com
@@ -49,12 +90,12 @@ files:
 - .rspec
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
 - french_man.gemspec
 - lib/french_man.rb
 - spec/french_man_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -84,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: french_man
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: machinist but just for hashes and arrays