nashie 0.0.3 → 0.0.5

data/Gemfile

@@ -4,5 +4,6 @@ source 'https://rubygems.org'
 
 group :test do
   gem "rspec"
+  gem "pry"
 end
 gemspec

data/README.md

@@ -1,6 +1,8 @@
 # Nashie
-Nashie provides a Hashie that can nest other Hashies.
-This allows you to rapidly create complex nested hashes.
+
+Nashie takes the Hashie concept one step further and allows you to create nested structure with buildin validation logic.
+
+Nashies are used in the wild as presenters for API responses and to validate incoming API calls.
 
 ## Installation
 
@@ -18,16 +20,49 @@ Or install it yourself as:
 
 ## Usage
 
+    class Part < Hashie::Nash
+       property :name, :required => true
+    end
+
+    class Engine < Hashie::Nash
+      property :build_year, :required => true
+      property :nitro, :default => false
+      property :parts, :collection => true, :class => "Part"
+    end
+
     class Car < Hashie::Nash
-      class Engine < Hashie::Nash
-        property :crankshaft, :required => true
-        property :nitro, :default => false
+      property :engine, :required => true, :class => Engine
+    end
+
+    car = Car.new "engine" => {"build_year" => 2010, "nitro" => false, :parts => [{"name" => "crankshaft"}, {"name" => "flywheel"}]}
+## Overrides
+
+It's possible that you have custom validation logic that is not covered by nashies.
+Internally nashies use the "new" class method which can be overridden if needed.
+
+   class Motorcycle
+      def self.new hash
+        raise "Euhm, a motorcycle has 2 wheels you know..." if not hash[:wheels].eql? 2
+        super hash
+      end
+   end
+
+## DSL
+
+A DSL is created that acts similar, it works by autocreating the classes as illustrated above (namespaced to the parent class).
+The example below for example will convert the block to a Presentation::Users class with similar properties.
+The block body passed to the property is executed on the class-level so you can define methods and override methods if needed.
+
+    class Presentation < Hashie::Nash
+      property :users, :collection => true, :required => true do
+         property :name
       end
-      
-      property :engine, :required => true, :class => Engine 
     end
 
-    Car.new "engine" => {"crankshaft" => true, "nitro" => false}
+## Future work
+
+- more types of validations
+- Customizable error messages
 
 ## Contributing
 

data/lib/nash/version.rb

@@ -1,3 +1,3 @@
 module Nash
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/nashie.rb

@@ -1,16 +1,16 @@
 require "nash/version"
-require 'hashie/dash'
+require 'hashie/trash'
 require 'set'
 
 module Hashie
   # A Nash is a Nested Defined Hash and is an extension of a Dash
-  # A Nash allows you to create complex assignments composing of 
+  # A Nash allows you to create complex assignments composing of
   # several nested Dashes
-  # 
   #
-  # Nashes are useful when you need to create a lightweigth nested 
+  #
+  # Nashes are useful when you need to create a lightweigth nested
   # data object, ideal for validating JSON
-  class Nash < Hashie::Dash
+  class Nash < Hashie::Trash
     include Hashie::PrettyInspect
     alias_method :to_s, :inspect
 
@@ -34,7 +34,14 @@ module Hashie
     #   should be instantiated when an assignment is made to this
     #   property.
     #
-    def self.property(property_name, options = {})
+    def self.property(property_name, options = {}, &block)
+          if block_given?
+            # if my college professor sees this he will personally come and beat the shit out of me :(
+            class_name = property_name.to_s.capitalize
+            class_ref = const_set(class_name, Class.new(Hashie::Nash))
+            class_ref.class_eval &block
+            options[:class] = class_name
+          end
           property_name = property_name.to_sym
 
           self.properties << property_name
@@ -42,18 +49,45 @@ module Hashie
           if options.has_key?(:class)
             class_name = options[:class].to_s
             class_properties[property_name] = class_name if options.delete(:class)
-            class_eval <<-ACCESSORS
-              def #{property_name}(&block)
-                self.[](#{property_name.to_s.inspect}, &block)
-              end
+            if not options[:collection]
+              class_eval <<-ACCESSORS
+                def #{property_name}(&block)
+                  self.[](#{property_name.to_s.inspect}, &block)
+                end
+
+                def #{property_name}=(value)
+                  self.[]=(#{property_name.to_s.inspect}, #{class_properties[property_name]}.new(value))
+                end
+
+              ACCESSORS
+            else
+              # expect arrays and convert single items into arrays
+              class_eval <<-ACCESSORS
+                def #{property_name}(&block)
+                  self.[](#{property_name.to_s.inspect}, &block)
+                end
+
+                def #{property_name}=(value)
+                  if not value.is_a? Array
+                    if #{options[:permissive]}
+                      value = [value]
+                    else
+                      raise "#{property_name} requires an array, use :permissive => true to automatically convert to array"
+                    end
+                  end
+                  values = []
+                  value.each do |item|
+                    values << #{class_properties[property_name]}.new(item)
+                  end
+                  values =
+                  self.[]=(#{property_name.to_s.inspect}, values)
+                end
+
+              ACCESSORS
+
+            end
+
 
-              def #{property_name}=(value)
-                self.[]=(#{property_name.to_s.inspect}, #{class_properties[property_name]}.new(value))
-              end
-              
-            ACCESSORS
-            
-            
           elsif
             class_properties[property_name] = nil
           end
@@ -97,11 +131,11 @@ module Hashie
     # You may initialize a Dash with an attributes hash
     # just like you would many other kinds of data objects.
     def initialize(attributes = {}, &block)
-      super(attributes, &block) 
-      
+      super(attributes, &block)
+
       # override whatever Dash has set
       attributes.each_pair do |att, value|
-        self.send((att.to_s + '=').to_sym,value) 
+        self.send((att.to_s + '=').to_sym,value)
       end if attributes
       assert_required_properties_set!
     end

data/nashie.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/nash/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["noverloop"]
-  gem.email         = ["nicolas@geckoboard.com"]
+  gem.email         = ["nicolas@noverloop.be"]
   gem.description   = %q{Nashie is an extension of Hashie and stands for Nested Hashie. Nashie allows you to create hashes that include other objects}
   gem.summary       = %q{Nashie allows you to create nested Hashie structures}
   gem.homepage      = ""

data/spec/nashie_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe Hashie::Nash do
+
+  class Test1 < Hashie::Nash
+    property :meh,:required => true
+  end
+
+  class NestedTest < Hashie::Nash
+    property :nest, :class => Test1
+  end
+
+  class NestedWithStringTest < Hashie::Nash
+    property :nest, :class => "Test1"
+  end
+
+  class Phrase < Hashie::Nash
+    property :phrase, :required => true
+  end
+
+  class NestedList < Hashie::Nash
+    property :nests, :class => "Phrase", :collection => true
+  end
+
+  it "should create a new Test1" do
+     t = Test1.new "meh"=> 5
+     t.nil?.should == false
+  end
+
+  it "should create a new NestedTest" do
+     t = NestedTest.new "nest" => {"meh"=> 5}
+     t.nil?.should == false
+  end
+
+  it "should make nested hashes accessible" do
+    t = NestedTest.new "nest" => {"meh"=> 5}
+    t.nest.meh.should == 5
+  end
+
+  it "should make nested hashes with strings accessible" do
+    t = NestedWithStringTest.new "nest" => {"meh"=> 5}
+    t.nest.meh.should == 5
+  end
+
+  it "should deal with collections of items properly" do
+    t = NestedList.new "nests" => [{"phrase" => "phrase 1"}, {"phrase" => "phrase 2"}]
+    t.nests.count.should == 2
+    t.nests.first.phrase.should == "phrase 1"
+  end
+
+  it "should make validate required properties in nested dash" do
+    lambda do
+    t = NestedTest.new "nest" => {"non_existent"=> 5}
+    t.nest.meh.should == 5
+    end.should raise_error NoMethodError
+  end
+
+  class Part < Hashie::Nash
+     property :name, :required => true
+  end
+
+  class Engine < Hashie::Nash
+    property :build_year, :required => true
+    property :nitro, :default => false
+    property :parts, :collection => true, :class => "Part"
+  end
+
+  class Car < Hashie::Nash
+    property :engine, :required => true, :class => Engine
+  end
+
+
+  it "should make validate required properties in nested dash" do
+    car = Car.new "engine" => {"build_year" => 2010, "nitro" => false, :parts => [{"name" => "crankshaft"}, {"name" => "flywheel"}]}
+    car.engine.build_year.should == 2010
+    car.engine.nitro.should be_false
+    car.engine.parts.count.should == 2
+    car.engine.parts.first.name.should == "crankshaft"
+  end
+
+  class Presentation < Hashie::Nash
+    property :users, :collection => true, :required => true do
+       property :name
+    end
+  end
+  require "pry"
+  it "should accept blocks" do
+    p = Presentation.new :users => [{"name"=> "Bob"}, {"name"=>"Eve"}]
+    p.users.count.should == 2
+    p.users.first.name.should == "Bob"
+  end
+end

metadata

@@ -1,87 +1,83 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nashie
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  version: 0.0.3
 platform: ruby
-authors: 
-  - noverloop
+authors:
+- noverloop
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-09 00:00:00 Z
-dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: hashie
-    prerelease: false
-    requirement: &id001 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-    type: :runtime
-    version_requirements: *id001
-  - !ruby/object:Gem::Dependency 
-    name: rake
-    prerelease: false
-    requirement: &id002 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-    type: :development
-    version_requirements: *id002
-description: Nashie is an extension of Hashie and stands for Nested Hashie. Nashie allows you to create hashes that include other objects
-email: 
-  - nicolas@geckoboard.com
+date: 2013-04-12 00:00:00.000000000 +01:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &2164468960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164468960
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2164468400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164468400
+description: Nashie is an extension of Hashie and stands for Nested Hashie. Nashie
+  allows you to create hashes that include other objects
+email:
+- nicolas@noverloop.be
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-  - .gitignore
-  - .rspec
-  - Gemfile
-  - LICENSE
-  - README.md
-  - Rakefile
-  - lib/nash/version.rb
-  - lib/nashie.rb
-  - nashie.gemspec
-  - spec/nash_spec.rb
-  - spec/spec_helper.rb
-homepage: ""
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nash/version.rb
+- lib/nashie.rb
+- nashie.gemspec
+- spec/nashie_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
-  - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.9
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Nashie allows you to create nested Hashie structures
-test_files: 
-  - spec/nash_spec.rb
-  - spec/spec_helper.rb
+test_files:
+- spec/nashie_spec.rb
+- spec/spec_helper.rb

data/spec/nash_spec.rb

@@ -1,49 +0,0 @@
-require 'spec_helper'
-
-describe Hashie::Nash do
-  
-  class Test1 < Hashie::Nash
-    property :meh,:required => true
-  end
-  
-  class NestedTest < Hashie::Nash
-    property :nest, :class => Test1 
-  end
-  
-  it "should create a new Test1" do
-     t = Test1.new "meh"=> 5
-     t.nil?.should == false
-  end
-  
-  it "should create a new NestedTest" do
-     t = NestedTest.new "nest" => {"meh"=> 5}
-     t.nil?.should == false
-  end
-  
-  it "should make nested hashes accessible" do
-    t = NestedTest.new "nest" => {"meh"=> 5}
-    t.nest.meh.should == 5
-  end
-  
-  it "should make validate required properties in nested dash" do
-    lambda do
-    t = NestedTest.new "nest" => {"non_existent"=> 5}
-    t.nest.meh.should == 5
-    end.should raise_error NoMethodError
-  end
-
-  class Car < Hashie::Nash
-    class Engine < Hashie::Nash
-      property :crankshaft, :required => true
-      property :nitro, :default => false
-    end
-    property :engine, :required => true, :class => Engine 
-  end
-
-
-  it "should make validate required properties in nested dash" do
-    c = Car.new "engine" => {"crankshaft" => true, "nitro" => false}
-    c.engine.crankshaft.should == true
-  end
-
-end