chozo 0.4.2 → 0.5.0

data/.rbenv-version

@@ -1 +1 @@
-1.9.3-p286
+1.9.3-p327

data/lib/chozo.rb

@@ -1,7 +1,10 @@
 # @author Jamie Winsor <jamie@vialstudios.com>
 module Chozo
+  autoload :CleanRoom, 'chozo/clean_room'
+  autoload :CleanRoomBase, 'chozo/clean_room_base'
   autoload :Config, 'chozo/config'
   autoload :Errors, 'chozo/errors'
+  autoload :Mixin, 'chozo/mixin'
   autoload :Platform, 'chozo/platform'
   autoload :RubyEngine, 'chozo/ruby_engine'
   autoload :VariaModel, 'chozo/varia_model'

data/lib/chozo/clean_room.rb

@@ -0,0 +1,79 @@
+module Chozo
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  module CleanRoom
+    module ClassMethods
+      @noisy_clean_room = false
+
+      # @return [CleanRoomBase]
+      def clean_room
+        @clean_room ||= CleanRoom.fabricate(self)
+      end
+
+      # @param [#to_s] filepath
+      #
+      # @return [Cookbook::Metadata]
+      def from_file(filepath)
+        filepath = filepath.to_s
+
+        if File.extname(filepath) =~ /\.json/
+          from_json_file(filepath)
+        else
+          from_ruby_file(filepath)
+        end
+      end
+
+      def from_json_file(filepath)
+        json_metadata = JSON.parse(File.read(filepath))
+        
+        obj = new
+        obj.clean_eval do
+          json_metadata.each { |key, val| send(key.to_sym, val) }
+        end
+        obj
+      end
+
+      def from_ruby_file(filepath)
+        obj = new
+        obj.clean_eval(File.read(filepath), filepath, 1)
+        obj
+      end
+
+      def set_clean_room(klass)
+        @clean_room = klass
+      end
+
+      def noisy_clean_room(value = nil)
+        if value.nil?
+          @noisy_clean_room
+        else
+          @noisy_clean_room = value
+        end
+      end
+    end
+
+    class << self
+      def included(base)
+        base.extend(ClassMethods)
+        base.send(:include, Chozo::VariaModel)
+      end
+
+      def fabricate(klass)
+        Class.new(CleanRoomBase) do
+          klass.attributes.each do |name, _|
+            dsl_attr_writer name.to_sym
+          end
+        end
+      end
+    end
+
+    # @param [String, Proc] data
+    def clean_eval(*args, &block)
+      data = args.shift
+      unless data.nil?
+        block = data.is_a?(Proc) ? data : proc { eval(data, binding, *args) }
+      end
+
+      self.class.clean_room.new(self).instance_eval(&block)
+    end
+  end
+end

data/lib/chozo/clean_room_base.rb

@@ -0,0 +1,36 @@
+module Chozo
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  class CleanRoomBase
+    class << self
+      # Create a DSL writer function that will assign the a given value
+      # to the real object of this clean room.
+      #
+      # @param [Symbol] attribute
+      def dsl_attr_writer(attribute)
+        class_eval do
+          define_method(attribute) do |value|
+            set_attribute(attribute, value)
+          end
+        end
+      end
+    end
+
+    def initialize(real_model)
+      @real_model = real_model
+      @noisy      = real_model.class.noisy_clean_room
+    end
+
+    private
+
+      attr_reader :noisy
+      attr_reader :real_model
+
+      def set_attribute(name, value)
+        real_model.send("#{name}=", value)
+      end
+
+      def method_missing(*args)
+        noisy ? super : nil
+      end
+  end
+end

data/lib/chozo/config/abstract.rb

@@ -23,7 +23,7 @@ module Chozo
       end
 
       def to_hash
-        self.attributes.to_hash.deep_symbolize_keys
+        super.to_hash.deep_symbolize_keys
       end
     end
   end

data/lib/chozo/config/json.rb

@@ -52,7 +52,7 @@ module Chozo
       #
       # @return [Chozo::Config::JSON]
       def reload
-        mass_assign(self.class.from_file(path).attributes)
+        mass_assign(self.class.from_file(path).to_hash)
         self
       end
     end

data/lib/chozo/core_ext/hash/dotted_paths.rb

@@ -31,15 +31,15 @@ class Hash
     #     }
     #   }
     #
-    # @param [String, Array] dotpath
-    # @param [Object] seed
-    # @param [Hash] target
+    # @param [String, Symbol, Array] dotpath
+    # @param [Object] seed (nil)
+    # @param [Hash] target (self.new)
     #
     # @return [Hash]
     def from_dotted_path(dotpath, seed = nil, target = self.new)
       case dotpath
-      when String
-        from_dotted_path(dotpath.split("."), seed)
+      when String, Symbol
+        from_dotted_path(dotpath.to_s.split("."), seed)
       when Array
         if dotpath.empty?
           return target

data/lib/chozo/mixin.rb

@@ -0,0 +1,10 @@
+module Chozo
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  #
+  # A collection of helpful mixins 
+  module Mixin; end
+end
+
+Dir["#{File.dirname(__FILE__)}/mixin/*.rb"].sort.each do |path|
+  require "chozo/mixin/#{File.basename(path, '.rb')}"
+end

data/lib/chozo/mixin/from_file.rb

@@ -0,0 +1,54 @@
+module Chozo::Mixin
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  module FromFile
+    module ClassMethods
+      def from_file(filename, *args)
+        new(*args).from_file(filename)
+      end
+
+      def class_from_file(filename, *args)
+        new(*args).class_from_file(filename)
+      end
+    end
+
+    class << self
+      def included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    # Loads the contents of a file within the context of the current object
+    #
+    # @param [#to_s] filename
+    #   path to the file to load
+    #
+    # @raise [IOError] if the file does not exist or cannot be read
+    def from_file(filename)
+      filename = filename.to_s
+
+      if File.exists?(filename) && File.readable?(filename)
+        self.instance_eval(IO.read(filename), filename, 1)
+        self
+      else
+        raise IOError, "Could not open or read: '#{filename}'"
+      end
+    end
+
+    # Loads the contents of a file within the context of the current object's class
+    #
+    # @param [#to_s] filename
+    #   path to the file to load
+    #
+    # @raise [IOError] if the file does not exist or cannot be read
+    def class_from_file(filename)
+      filename = filename.to_s
+
+      if File.exists?(filename) && File.readable?(filename)
+        self.class_eval(IO.read(filename), filename, 1)
+        self
+      else
+        raise IOError, "Could not open or read: '#{filename}'"
+      end
+    end
+  end
+end

data/lib/chozo/varia_model.rb

@@ -11,14 +11,14 @@ module Chozo
         :carefree
       ]
 
-      # @return [HashWithIndifferentAccess]
+      # @return [Hashie::Mash]
       def attributes
         @attributes ||= Hashie::Mash.new
       end
 
-      # @return [HashWithIndifferentAccess]
+      # @return [Hashie::Mash]
       def validations
-        @validations ||= HashWithIndifferentAccess.new
+        @validations ||= Hashie::Mash.new
       end
 
       # @return [Symbol]
@@ -73,7 +73,7 @@ module Chozo
         matches = false
 
         types.each do |type|
-          if model.attributes.dig(key).is_a?(type)
+          if model.get_attribute(key).is_a?(type)
             matches = true
             break
           end
@@ -94,7 +94,7 @@ module Chozo
       #
       # @return [Array]
       def validate_required(model, key)
-        if model.attributes.dig(key).nil?
+        if model.get_attribute(key).nil?
           [ :error, "A value is required for attribute: '#{key}'" ]
         else
           [ :ok, "" ]
@@ -138,7 +138,7 @@ module Chozo
           
           class_eval do
             define_method fun_name do
-              self.attributes[fun_name]
+              _attributes_[fun_name]
             end
 
             define_method "#{fun_name}=" do |value|
@@ -148,7 +148,7 @@ module Chozo
                 value
               end
 
-              self.attributes[fun_name] = value
+              _attributes_[fun_name] = value
             end
           end
         end
@@ -160,11 +160,6 @@ module Chozo
       end
     end
 
-    # @return [HashWithIndifferentAccess]
-    def attributes
-      @attributes ||= self.class.attributes.dup
-    end
-
     # @return [HashWithIndifferentAccess]
     def validate
       self.class.validations.each do |attr_path, validations|
@@ -196,6 +191,16 @@ module Chozo
       @errors ||= HashWithIndifferentAccess.new
     end
 
+    # Assigns the attributes of a model from a given hash of attributes.
+    #
+    # If the assignment mode is set to `:whitelist`, then only the values of keys which have a
+    # corresponding attribute definition on the model will be set. All other keys will have their
+    # values ignored.
+    #
+    # If the assignment mode is set to `:carefree`, then the attributes hash will be populated
+    # with any key/values that are provided.
+    #
+    # @param [Hash] new_attrs
     def mass_assign(new_attrs = {})
       case self.class.assignment_mode
       when :whitelist
@@ -204,20 +209,19 @@ module Chozo
         carefree_assign(new_attrs)
       end
     end
-    alias_method :attributes=, :mass_assign
 
     # @param [#to_s] key
     #
     # @return [Object]
     def get_attribute(key)
-      self.attributes.dig(key.to_s)
+      _attributes_.dig(key.to_s)
     end
     alias_method :[], :get_attribute
 
     # @param [#to_s] key
     # @param [Object] value
     def set_attribute(key, value)
-      self.attributes.deep_merge!(attributes.class.from_dotted_path(key.to_s, value))
+      _attributes_.deep_merge!(Hashie::Mash.from_dotted_path(key.to_s, value))
     end
     alias_method :[]=, :set_attribute
 
@@ -237,17 +241,20 @@ module Chozo
       self
     end
 
-    # @return [Hash]
-    def to_hash
-      self.attributes
+    # The storage hash containing all of the key/values for this object's attributes
+    #
+    # @return [Hashie::Mash]
+    def _attributes_
+      @_attributes_ ||= self.class.attributes.dup
     end
+    alias_method :to_hash, :_attributes_
 
     # @option options [Boolean] :symbolize_keys
     # @option options [Class, Symbol, String] :adapter
     #
     # @return [String]
     def to_json(options = {})
-      MultiJson.encode(self.attributes, options)
+      MultiJson.encode(_attributes_, options)
     end
     alias_method :as_json, :to_json
 
@@ -263,7 +270,7 @@ module Chozo
     private
 
       def carefree_assign(new_attrs = {})
-        attributes.deep_merge!(new_attrs)
+        _attributes_.deep_merge!(new_attrs)
       end
 
       def whitelist_assign(new_attrs = {})

data/lib/chozo/version.rb

@@ -1,3 +1,3 @@
 module Chozo
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/spec/unit/chozo/clean_room_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe Chozo::CleanRoom do
+  describe "ClassMethods" do
+    subject do
+      Class.new do
+        include Chozo::CleanRoom
+
+        attribute 'one'
+      end
+    end
+
+    describe "::clean_room" do
+      it "returns an anonymous class" do
+        subject.clean_room.class.should eql(Class)
+      end
+
+      it "has a superlcass of CleanRoomBase" do
+        subject.clean_room.superclass.should eql(Chozo::CleanRoomBase)
+      end
+    end
+
+    describe "::from_ruby_file" do
+      let(:file) { tmp_path.join('rspec').to_s }
+
+      before(:each) do
+        File.open(file, 'w+') do |f|
+          f.write <<-TXT
+            one 'value'
+          TXT
+        end
+      end
+
+      it "returns self" do
+        result = subject.from_ruby_file(file)
+        result.should be_a(subject)
+      end
+    end
+
+    describe "::from_json_file" do
+      pending
+    end
+  end
+
+  subject do
+    Class.new do
+      include Chozo::CleanRoom
+
+      attribute 'one', type: String
+      attribute 'two.three'
+    end.new
+  end
+
+  describe "#clean_eval" do
+    it "evaluates a string" do
+      string = <<-RB
+        one 'value'
+      RB
+
+      subject.clean_eval(string)
+      subject.one.should eql("value")
+    end
+
+    it "evaluates a block" do
+      subject.clean_eval do
+        one 'value'
+      end
+
+      subject.one.should eql("value")
+    end
+
+    it "evaluates a proc" do
+      code = proc {
+        one "value"
+      }
+
+      subject.clean_eval(code)
+    end
+
+    it "responds to a message for each class attribute" do
+      subject.class.attributes.each do |message, _|
+        subject.should respond_to(message.to_sym)
+      end
+    end
+
+    context "strict clean room: false" do
+      subject do
+        Class.new do
+          include Chozo::CleanRoom
+          noisy_clean_room(false)
+        end.new
+      end
+
+      it "doesn't raise an error if an unknown attribute is accessed" do
+        subject.clean_eval do
+          one 'hello'
+          three 'asdf'
+        end
+      end
+    end
+
+    context "strict clean room: true" do
+      subject do
+        Class.new do
+          include Chozo::CleanRoom
+          noisy_clean_room(true)
+        end.new
+      end
+
+      it "raises NoMethodError if an unknown attribute is accessed" do
+        expect {
+          subject.clean_eval do
+            one 'hello'
+          end
+        }.to raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/unit/chozo/config/abstract_spec.rb

@@ -9,7 +9,7 @@ describe Chozo::Config::Abstract do
     end
 
     it "contains all of the attributes" do
-      subject.attributes[:something] = "value"
+      subject.set_attribute(:something, "value")
       
       subject.to_hash.should have_key(:something)
       subject.to_hash[:something].should eql("value")
@@ -18,12 +18,8 @@ describe Chozo::Config::Abstract do
 
   describe "#slice" do
     before(:each) do
-      subject.attributes[:one] = {
-        nested: "value"
-      }
-      subject.attributes[:two] = {
-        nested: "other"
-      }
+      subject.set_attribute(:one, nested: "value")
+      subject.set_attribute(:two, nested: "other")
       @sliced = subject.slice(:one)
     end
 

data/spec/unit/chozo/core_ext/hash/dotted_paths_spec.rb

@@ -9,7 +9,7 @@ describe Hash do
         subject.from_dotted_path("deep.nested.item").should be_a(Hash)
       end
 
-      it "a hash containing the nested keys" do
+      it "returns a hash containing the nested keys" do
         obj = subject.from_dotted_path("deep.nested.item")
 
         obj.should have_key("deep")
@@ -23,6 +23,12 @@ describe Hash do
         obj["deep"]["nested"]["item"].should be_nil
       end
 
+      it "handles a symbol as the dotted path" do
+        obj = subject.from_dotted_path(:"a.b.c", "value")
+        
+        obj["a"]["b"]["c"].should == "value"
+      end
+
       context "when given a seed value" do
         it "sets the value of the deepest nested item to the seed" do
           obj = subject.from_dotted_path("deep.nested.item", "seeded_value")

data/spec/unit/chozo/mixin/from_file_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Chozo::Mixin::FromFile do
+  describe "ClassMethods" do
+    let(:file) { double('file') }
+    let(:args) { double('args') }
+
+    subject do
+      Class.new do
+        include Chozo::Mixin::FromFile
+      end
+    end
+
+    describe "::from_file" do
+      it "initializes a new class and delegates to #from_file" do
+        instance = double('instance')
+        subject.should_receive(:new).with(args).and_return(instance)
+        instance.should_receive(:from_file).with(file)
+
+        subject.from_file(file, args)
+      end
+    end
+
+    describe "::class_from_file" do
+      it "initializes a new class and delegates to #class_from_file" do
+        instance = double('instance')
+        subject.should_receive(:new).with(args).and_return(instance)
+        instance.should_receive(:class_from_file).with(file)
+
+        subject.class_from_file(file, args)
+      end
+    end
+  end
+
+  subject do
+    Class.new do
+      include Chozo::Mixin::FromFile
+    end.new
+  end
+
+  describe "#from_file" do
+    let(:file) { tmp_path.join('rspec-test').to_s }
+
+    before(:each) do
+      File.open(file, 'w+') do |f|
+        f.write <<-CODE
+          def hello
+            1+1
+          end
+        CODE
+      end
+    end
+
+    it "evaluates the contents of the file in a new instance of the including class" do
+      subject.from_file(file).should respond_to(:hello)
+    end
+
+    it "returns a new instance of the including class" do
+      subject.from_file(file).should be_a(subject.class)
+    end
+
+    it "it raises IOError if the file cannot be read" do
+      expect {
+        subject.from_file("/doesnot/exist")
+      }.to raise_error(IOError)
+    end
+  end
+
+  describe "#class_from_file" do
+    it "it raises IOError if the file cannot be read" do
+      expect {
+        subject.class_from_file("/doesnot/exist")
+      }.to raise_error(IOError)
+    end
+  end
+end

data/spec/unit/chozo/varia_model_spec.rb

@@ -43,11 +43,23 @@ describe Chozo::VariaModel do
 
         subject.attributes.dig('brooke.winsor').should eql('rhode island')
       end
+
+      it "allows an attribute called 'attributes'" do
+        subject.attribute 'attributes', default: 'bag of junk'
+
+        subject.attributes.dig('attributes').should eql('bag of junk')
+      end
+
+      it "allows an attribute called 'attribute'" do
+        subject.attribute 'attribute', default: 'some value'
+
+        subject.attributes.dig('attribute').should eql('some value')
+      end
     end
 
     describe "::validations" do
-      it "returns a HashWithIndifferentAccess" do
-        subject.validations.should be_a(HashWithIndifferentAccess)
+      it "returns a Hashie::Mash" do
+        subject.validations.should be_a(Hashie::Mash)
       end
 
       it "is empty by default" do
@@ -380,6 +392,25 @@ describe Chozo::VariaModel do
         subject.nested.two.should eql("2")
       end
     end
+
+    context "given an attribute called 'attributes'" do
+      subject do
+        Class.new do
+          include Chozo::VariaModel
+
+          attribute 'attributes', default: Hash.new
+        end.new
+      end
+
+      it "allows the setting and getting of the 'attributes' mimic methods" do
+        subject.attributes.should be_a(Hash)
+        subject.attributes.should be_empty
+
+        new_hash = { something: "here" }
+        subject.attributes = new_hash
+        subject.attributes[:something].should eql("here")
+      end
+    end
   end
 
   describe "Validations" do
@@ -524,7 +555,7 @@ describe Chozo::VariaModel do
       }
 
       subject.mass_assign(new_attrs)
-      subject.attributes[:undefined_attribute].should be_nil
+      subject.get_attribute(:undefined_attribute).should be_nil
       subject.should_not respond_to(:undefined_attribute)
     end
 
@@ -543,7 +574,7 @@ describe Chozo::VariaModel do
         }
 
         subject.mass_assign(new_attrs)
-        subject.attributes[:undefined_attribute].should eql("value")
+        subject.get_attribute(:undefined_attribute).should eql("value")
       end
     end
   end
@@ -611,8 +642,8 @@ describe Chozo::VariaModel do
   end
 
   describe "#to_hash" do
-    it "returns the attributes" do
-      subject.to_hash.should eql(subject.attributes)
+    it "returns all of the varia dattributes" do
+      subject.to_hash.should eql(subject.send(:_attributes_))
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chozo
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,6 +76,8 @@ files:
 - Thorfile
 - chozo.gemspec
 - lib/chozo.rb
+- lib/chozo/clean_room.rb
+- lib/chozo/clean_room_base.rb
 - lib/chozo/config.rb
 - lib/chozo/config/abstract.rb
 - lib/chozo/config/json.rb
@@ -90,6 +92,8 @@ files:
 - lib/chozo/hashie_ext.rb
 - lib/chozo/hashie_ext/hash.rb
 - lib/chozo/hashie_ext/mash.rb
+- lib/chozo/mixin.rb
+- lib/chozo/mixin/from_file.rb
 - lib/chozo/platform.rb
 - lib/chozo/ruby_engine.rb
 - lib/chozo/varia_model.rb
@@ -98,9 +102,11 @@ files:
 - spec/spec_helper.rb
 - spec/support/helpers.rb
 - spec/support/matchers/each.rb
+- spec/unit/chozo/clean_room_spec.rb
 - spec/unit/chozo/config/abstract_spec.rb
 - spec/unit/chozo/config/json_spec.rb
 - spec/unit/chozo/core_ext/hash/dotted_paths_spec.rb
+- spec/unit/chozo/mixin/from_file_spec.rb
 - spec/unit/chozo/platform_spec.rb
 - spec/unit/chozo/ruby_engine_spec.rb
 - spec/unit/chozo/varia_model_spec.rb
@@ -125,10 +131,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2200998191106118860
+      hash: 2558961002303153299
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A collection of supporting libraries and Ruby core extensions
@@ -137,9 +143,11 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/helpers.rb
 - spec/support/matchers/each.rb
+- spec/unit/chozo/clean_room_spec.rb
 - spec/unit/chozo/config/abstract_spec.rb
 - spec/unit/chozo/config/json_spec.rb
 - spec/unit/chozo/core_ext/hash/dotted_paths_spec.rb
+- spec/unit/chozo/mixin/from_file_spec.rb
 - spec/unit/chozo/platform_spec.rb
 - spec/unit/chozo/ruby_engine_spec.rb
 - spec/unit/chozo/varia_model_spec.rb