fedora_lens 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af9796406a65d286343ded62b45876a28f2c542f
-  data.tar.gz: c1237758ac4f5fc1131f9add45cbddf5d657c840
+  metadata.gz: 16b83b0c8b5f99413f3eec0f08a0b75609f35a7c
+  data.tar.gz: dec9a72626b9c00511782586aa8b904f63558380
 SHA512:
-  metadata.gz: 5bfca9e2b65760e3674ceb986153df14f6de8885c320287cd2367ade51aa1ca78cb0d97a824b479871df63e298442b4b49d590c6469b539984a00704cd440d2e
-  data.tar.gz: 9b4fe962ae9a7dc2e70fc9533129b2247e10acd14554247b3ebcdfa25c051f6620f779eadab9f4a3e7c1d4455af4e92c9c57e7e5cd989bf117102d805e3cfbfe
+  metadata.gz: 07dd2afaa5f9c46f2ecdbeba122c0aee828edf3240f2f52c37c3ecee72ad7ffef3a1a636389bfd6329b6997eb9b53cfcf4dd35681e0f64771a061d2294e25582
+  data.tar.gz: 7c9928a40da331750b368189327bef44f446c82a9ea05ccf50f5be08682bf811e17927e2e2cb2de3d5f67d37265feed71f87231c87f87f2625bce683a40d35c6

data/lib/fedora_lens.rb

@@ -13,6 +13,18 @@ require 'fedora_lens/errors'
 
 module FedoraLens
   extend ActiveSupport::Concern
+  extend ActiveSupport::Autoload
+  autoload :AttributeMethods
+
+  module AttributeMethods
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :Read
+      autoload :Write
+    end
+  end
+
   HOST = "http://localhost:8983/fedora"
   #HOST = "http://localhost:8080"
   PATH = '/rest'
@@ -25,11 +37,8 @@ module FedoraLens
     extend ActiveModel::Naming
     include ActiveModel::Validations
     include ActiveModel::Conversion
+    include FedoraLens::AttributeMethods
 
-    class_attribute :attributes_as_lenses
-    self.attributes_as_lenses = {}.with_indifferent_access
-
-    attr_reader :attributes
     attr_reader :orm
   end
 
@@ -134,18 +143,6 @@ module FedoraLens
       "#{HOST}#{PATH}#{id}"
     end
 
-    def attribute(name, path, options={})
-      raise AttributeNotSupportedException if name.to_sym == :id
-      attributes_as_lenses[name] = path.map{|s| coerce_to_lens(s)}
-      define_method name do
-        @attributes[name]
-      end
-      define_method "#{name}=" do |value|
-        @attributes[name] = value
-      end
-      orm_to_hash = nil # force us to rebuild the aggregate_lens in case it was already built.
-    end
-
     def create(data)
       model = self.new(data)
       model.save
@@ -164,14 +161,6 @@ module FedoraLens
       @orm_to_hash
     end
 
-    def coerce_to_lens(path_segment)
-      if path_segment.is_a? RDF::URI
-        Lenses.get_predicate(path_segment)
-      else
-        path_segment
-      end
-    end
-
     # def has_one(name, scope = nil, options = {})
     #   ActiveRecord::Associations::Builder::HasOne.build(self, name, scope, options)
     # end

data/lib/fedora_lens/attribute_methods.rb

@@ -0,0 +1,143 @@
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/class/attribute'
+
+module FedoraLens
+  module AttributeMethods
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+
+    AttrNames = Module.new {
+      def self.set_name_cache(name, value)
+        const_name = "ATTR_#{name}"
+        unless const_defined? const_name
+          const_set const_name, value.dup.freeze
+        end
+      end
+    }
+
+    class AttributeMethodCache
+      def initialize
+        @module = Module.new
+        @method_cache = ThreadSafe::Cache.new
+      end
+
+      def [](name)
+        @method_cache.compute_if_absent(name) do
+          safe_name = name.unpack('h*').first
+          temp_method = "__temp__#{safe_name}"
+          FedoraLens::AttributeMethods::AttrNames.set_name_cache safe_name, name
+          @module.module_eval method_body(temp_method, safe_name), __FILE__, __LINE__
+          @module.instance_method temp_method
+        end
+      end
+
+      private
+      def method_body; raise NotImplementedError; end
+    end
+
+
+    included do
+      class_attribute :attributes_as_lenses
+      self.attributes_as_lenses = {}.with_indifferent_access
+      
+      initialize_generated_modules
+      include Read
+      include Write
+    end
+
+    # Returns an array of names for the attributes available on this object.
+    #
+    #   class Person
+    #     include FedoraLens
+    #   end
+    #
+    #   person = Person.new
+    #   person.attribute_names
+    #   # => ["id", "created_at", "updated_at", "name", "age"]
+    def attribute_names
+      @attributes.keys
+    end
+
+    # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
+    #
+    #   class Person
+    #     include FedoraLens
+    #   end
+    #
+    #   person = Person.create(name: 'Francesco', age: 22)
+    #   person.attributes
+    #   # => {"id"=>3, "created_at"=>Sun, 21 Oct 2012 04:53:04, "updated_at"=>Sun, 21 Oct 2012 04:53:04, "name"=>"Francesco", "age"=>22}
+    def attributes
+      attribute_names.each_with_object({}) { |name, attrs|
+        attrs[name] = read_attribute(name)
+      }
+    end
+
+    
+    # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
+    # "2004-12-12" in a date column is cast to a date object, like Date.new(2004, 12, 12)). It raises
+    # <tt>ActiveModel::MissingAttributeError</tt> if the identified attribute is missing.
+    #
+    # Alias for the <tt>read_attribute</tt> method.
+    #
+    #   class Person < ActiveRecord::Base
+    #     belongs_to :organization
+    #   end
+    #
+    #   person = Person.new(name: 'Francesco', age: '22')
+    #   person[:name] # => "Francesco"
+    #   person[:age]  # => 22
+    #
+    #   person = Person.select('id').first
+    #   person[:name]            # => ActiveModel::MissingAttributeError: missing attribute: name
+    #   person[:organization_id] # => ActiveModel::MissingAttributeError: missing attribute: organization_id
+    def [](attr_name)
+      read_attribute(attr_name) { |n| missing_attribute(n, caller) }
+    end
+    
+    # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
+    # (Alias for the protected <tt>write_attribute</tt> method).
+    #
+    #   class Person
+    #     include FedoraLens
+    #   end
+    #
+    #   person = Person.new
+    #   person[:age] = '22'
+    #   person[:age] # => 22
+    #   person[:age] # => Fixnum
+    def []=(attr_name, value)
+      write_attribute(attr_name, value)
+    end
+
+    module ClassMethods
+      def initialize_generated_modules # :nodoc:
+        @generated_attribute_methods = Module.new { extend Mutex_m }
+        include @generated_attribute_methods
+      end
+
+      def attribute(name, path, options={})
+        raise AttributeNotSupportedException if name.to_sym == :id
+        attributes_as_lenses[name] = path.map{|s| coerce_to_lens(s)}
+        generate_method(name)
+        orm_to_hash = nil # force us to rebuild the aggregate_lens in case it was already built.
+      end
+
+      private
+        def coerce_to_lens(path_segment)
+          if path_segment.is_a? RDF::URI
+            Lenses.get_predicate(path_segment)
+          else
+            path_segment
+          end
+        end
+
+        # @param name [Symbol] name of the attribute to generate
+        def generate_method(name)
+          generated_attribute_methods.synchronize do
+            define_attribute_methods name
+          end
+        end
+    end
+  end
+end

data/lib/fedora_lens/attribute_methods/read.rb

@@ -0,0 +1,61 @@
+module FedoraLens
+  module AttributeMethods
+    module Read
+      ReaderMethodCache = Class.new(AttributeMethodCache) {
+        private
+        # We want to generate the methods via module_eval rather than
+        # define_method, because define_method is slower on dispatch.
+        # Evaluating many similar methods may use more memory as the instruction
+        # sequences are duplicated and cached (in MRI).  define_method may
+        # be slower on dispatch, but if you're careful about the closure
+        # created, then define_method will consume much less memory.
+        #
+        # But sometimes the database might return columns with
+        # characters that are not allowed in normal method names (like
+        # 'my_column(omg)'. So to work around this we first define with
+        # the __temp__ identifier, and then use alias method to rename
+        # it to what we want.
+        #
+        # We are also defining a constant to hold the frozen string of
+        # the attribute name. Using a constant means that we do not have
+        # to allocate an object on each call to the attribute method.
+        # Making it frozen means that it doesn't get duped when used to
+        # key the @attributes_cache in read_attribute.
+        def method_body(method_name, const_name)
+          <<-EOMETHOD
+          def #{method_name}
+            name = ::FedoraLens::AttributeMethods::AttrNames::ATTR_#{const_name}
+            read_attribute(name) { |n| missing_attribute(n, caller) }
+          end
+          EOMETHOD
+        end
+      }.new
+
+      extend ActiveSupport::Concern
+
+      # Returns the value of the attribute identified by <tt>attr_name</tt> after
+      # it has been typecast (for example, "2004-12-12" in a date column is cast
+      # to a date object, like Date.new(2004, 12, 12)).
+      def read_attribute(attr_name)
+        name = attr_name.to_s
+        @attributes.fetch(name, nil)
+      end
+
+      private
+        def attribute(attribute_name)
+          read_attribute(attribute_name)
+        end
+
+
+      module ClassMethods
+        def define_method_attribute(name)
+          method = ReaderMethodCache[name.to_s]
+          generated_attribute_methods.module_eval {
+            define_method name, method
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/fedora_lens/attribute_methods/write.rb

@@ -0,0 +1,50 @@
+module FedoraLens
+  module AttributeMethods
+    module Write
+      WriterMethodCache = Class.new(AttributeMethodCache) {
+        private
+
+        def method_body(method_name, const_name)
+          <<-EOMETHOD
+          def #{method_name}(value)
+            name = ::FedoraLens::AttributeMethods::AttrNames::ATTR_#{const_name}
+            write_attribute(name, value)
+          end
+          EOMETHOD
+        end
+      }.new
+
+      extend ActiveSupport::Concern
+
+      included do
+        attribute_method_suffix "="
+      end
+
+      def write_attribute(attribute_name, value)
+        #column = column_for_attribute(attribute_name)
+        column = true # TODO check that attribute_name is valid
+        
+        if column 
+          @attributes[attribute_name] = value
+        else
+          raise ActiveModel::MissingAttributeError, "can't write unknown attribute `#{attribute_name}'"
+        end
+      end
+
+      private
+        def attribute=(attribute_name, value)
+          write_attribute(attribute_name, value)
+        end
+
+      module ClassMethods
+        def define_method_attribute=(name)
+          method = WriterMethodCache[name.to_s]
+          generated_attribute_methods.module_eval {
+            define_method "#{name}=", method
+          }
+        end
+      end
+
+    end
+  end
+end

data/lib/fedora_lens/version.rb

@@ -1,3 +1,3 @@
 module FedoraLens
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/fedora_lens_spec.rb

@@ -95,7 +95,16 @@ describe FedoraLens do
   describe ".attribute" do
     it "makes a setter/getter" do
       subject.title = "foo"
-      subject.title.should eq "foo"
+      expect(subject.title).to eq "foo"
+    end
+
+    it "should return nil if it hasn't been set" do
+      expect(subject.title).to be_nil
+    end
+
+    it "has a [] setter/getter" do
+      subject[:title] = 'foo'
+      expect(subject[:title]).to eq 'foo'
     end
 
     it "loads from rdf" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedora_lens
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,9 @@ files:
 - fedora/.gitkeep
 - fedora_lens.gemspec
 - lib/fedora_lens.rb
+- lib/fedora_lens/attribute_methods.rb
+- lib/fedora_lens/attribute_methods/read.rb
+- lib/fedora_lens/attribute_methods/write.rb
 - lib/fedora_lens/errors.rb
 - lib/fedora_lens/lens.rb
 - lib/fedora_lens/lens_tests.rb