active_fedora-registered_attributes 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dac8cbef5f9c4b50b43a392200ac5ad508c946a
-  data.tar.gz: 24c9889b73ad5b4cd584323c7a654d72877ab4ca
+  metadata.gz: 1f3ebbd73ebefa0ab6879e1c931ba1e910d57cc3
+  data.tar.gz: 9f3e8bffeb4f9a856436ab3eeb14fc845481613e
 SHA512:
-  metadata.gz: 5c056a733cd092784c5b730fe233c1988c3cb65e2cc116a7ab36e1cfff5c595fd2337492e78cf6b07c5eeba5ecb064fc6a1d602508283abbb9f75ae4857b18fd
-  data.tar.gz: 2bf802fc4d7178567339b552a84a51e12f8befe12cfdff0163371b5012d55c729ee19360f700fb3e0daa2184af66f0b278185e5698f92d5254da56617709c805
+  metadata.gz: 9f3dbba63bb918a6ba656116f3d04336ba738b1f7af4928bff84eb538c665d3d09fcefc4760e15b4331ac9404827197e4c4f87c3a5005b23cb18591071c6c37f
+  data.tar.gz: be2a203b103986dc7ed68f03c6f2de2770be7719fc932c74bbfaa88de0c79033e7ca0b1cc9dff8c5020e77c68e9b6f7f75c69b0d20d29d65b6b5f1fbf67ea26f

data/README.md

@@ -4,6 +4,13 @@
 
 An ActiveFedora extension for consolidating the attribute definitions for an object.
 
+By registering an attribute, we can introspect on the model for:
+
+* generating forms
+* generating default views
+* generating reasonably helpful API documentation/explanation
+* helping developers readily see what the data attributes are
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -39,6 +46,8 @@ Or install it yourself as:
         validates: { presence: { message: "You must have an author."} }
     end
 
+See [ActiveFedora::RegisteredAttributes::Attribute](lib/active_fedora/registered_attributes/attribute.rb)
+
 ## Internationalization
 
 If you utilize internationalization, such as below, then regardless of what

data/lib/active_fedora/registered_attributes/attribute.rb

@@ -5,10 +5,41 @@ module ActiveFedora
       attr_reader :context_class, :name, :datastream
       private :context_class
 
+      # == Parameters:
+      # @param context_class [ActiveFedora::Base, #human_attribute_name]
+      #    A descendant of ActiveFedora::Base.
+      #    Though generally speaking it may work with other ActiveModel descendants
+      #
+      # @param name [String, Symbol]
+      #    The name of the attribute (i.e. "title", "subject", "description").
+      # @param [Hash] options Configuration options
+      # @option options [Symbol, #call] :default
+      # @option options [Boolean] :displayable (true)
+      # @option options [Boolean] :editable (true)
+      #    By marking this attribute :editable
+      # @option options [Hash] :form
+      #    Additional options for a form builder (i.e. class, id, data-attribute)
+      # @option options [Symbol, String, Nil, Hash] :datastream
+      #    Where will the attribute persist; This can be nil. If nil, this would
+      #    be a virtual attribute (i.e. attr_accessor name). If it is not nil,
+      #    then see {#options_for_delegation}
+      # @option options [Hash] :validates
+      #    A hash that can be used as the args for ActiveModel::Validations::ClassMethods.validates
+      # @option options [Boolean] :multiple (false)
+      #    Can there be multiple values for this attribute?
+      #    Used to derive an option for ActiveFedora::Base.delegate
+      # @option options [Symbol, #call] :writer
+      #    Before we persist the attribute, pass the value through the :writer
+      # @option options [Symbol, #call] :reader
+      #    After we retrieve the value from its persistence, transform the value via the :reader
+      # @option options [#to_s] :label (internationalization)
+      #    If we were to build a form from this, what would we use as the label
+      # @option options [#to_s] :hint
+      #    A supplement to the Attribute's :label
       def initialize(context_class, name, options = {})
         @context_class = context_class
         @options = options.symbolize_keys
-        @options.assert_valid_keys(:default, :displayable, :editable, :form, :datastream, :validates, :at, :as, :multiple, :writer, :reader, :label, :hint)
+        @options.assert_valid_keys(:default, :displayable, :editable, :form, :datastream, :validates, :multiple, :writer, :reader, :label, :hint)
         @datastream = @options.fetch(:datastream, false)
         @name = name
         @options[:multiple] = false unless @options.key?(:multiple)
@@ -44,7 +75,6 @@ module ActiveFedora
         options[:form].tap {|hash|
           hash[:hint] ||= options[:hint] if options[:hint]
           hash[:label] ||= options[:label] if options[:label]
-          hash[:as] ||= options[:as] if options[:as]
           if options[:multiple]
             hash[:as] = 'multi_value'
             hash[:input_html] ||= {}
@@ -87,12 +117,14 @@ module ActiveFedora
       private
 
         def options_for_delegation
-          {
-            to: datastream,
-            unique: !options[:multiple]
-          }.tap {|hash|
-            hash[:at] = options[:at] if options.key?(:at)
-          }
+          if datastream.is_a?(Hash)
+            datastream.merge(unique: !options[:multiple])
+          else
+            {
+              to: datastream,
+              unique: !options[:multiple]
+            }
+          end
         end
 
         def with_writer_method_wrap

data/lib/active_fedora/registered_attributes/version.rb

@@ -1,5 +1,5 @@
 module ActiveFedora
   module RegisteredAttributes
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/active_fedora/registered_attributes/attribute_spec.rb

@@ -47,14 +47,40 @@ describe ActiveFedora::RegisteredAttributes::Attribute do
 
   describe '#with_delegation_options' do
     describe 'with a datastream' do
-      it 'yields name and options' do
-        @yielded = false
-        subject.with_delegation_options {|name,opts|
-          @yielded = true
-          expect(name).to eq(field_name)
-          expect(opts).to eq(subject.send(:options_for_delegation))
+      let(:options) {
+        {
+          datastream: datastream,
+          multiple: true,
         }
-        expect(@yielded).to eq(true)
+      }
+      describe 'and minimal options' do
+        it 'yields name and options' do
+          @yielded = false
+          subject.with_delegation_options {|name,opts|
+            @yielded = true
+            expect(name).to eq(field_name)
+            expect(opts).to eq(to: datastream, unique: false)
+          }
+          expect(@yielded).to eq(true)
+        end
+      end
+      describe 'with :at options' do
+        let(:at_value) {[:ab]}
+        let(:options) {
+          {
+            multiple: true,
+            datastream: {to: datastream, at: at_value, unique: true }
+          }
+        }
+        it 'yields name and options' do
+          @yielded = false
+          subject.with_delegation_options {|name,opts|
+            @yielded = true
+            expect(name).to eq(field_name)
+            expect(opts).to eq(to: datastream, unique: !options.fetch(:multiple), at: at_value)
+          }
+          expect(@yielded).to eq(true)
+        end
       end
     end
     describe 'without datastream' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_fedora-registered_attributes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora