common_repository_model 0.0.6 → 0.0.7

data/lib/common_repository_model/area.rb

@@ -1,5 +1,6 @@
 require_relative './persistence_base'
 require_relative './collection'
+require_relative './area_serializer'
 module CommonRepositoryModel
   class Area < PersistenceBase
 
@@ -15,7 +16,7 @@ module CommonRepositoryModel
 
     validates :name, presence: true
 
-    delegate_to 'properties', [:name], unique: true
+    delegate :name, to: 'properties', unique: true
 
     def self.find_by_name(name)
       find({'name_s' => name}).first

data/lib/common_repository_model/area_serializer.rb

@@ -0,0 +1,4 @@
+require_relative './persistence_base_serializer'
+class CommonRepositoryModel::AreaSerializer < CommonRepositoryModel::PersistenceBaseSerializer
+  attribute :name
+end

data/lib/common_repository_model/collection.rb

@@ -2,6 +2,7 @@ require_relative './persistence_base'
 require_relative './area'
 require_relative './data'
 require 'set'
+require 'morphine'
 
 class PersistedValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
@@ -104,6 +105,15 @@ module CommonRepositoryModel
       end
     end
 
+    def area_name
+      area.name
+    end
+
+    include Morphine
+    register :named_area_finder do
+      CommonRepositoryModel::Area.method(:find_by_name!)
+    end
+
     belongs_to(
       :__area,
       class_name:'CommonRepositoryModel::Area',

data/lib/common_repository_model/collection_serializer.rb

@@ -0,0 +1,4 @@
+require_relative './persistence_base_serializer'
+class CommonRepositoryModel::CollectionSerializer < CommonRepositoryModel::PersistenceBaseSerializer
+  has_one :area, embed: :ids
+end

data/lib/common_repository_model/data.rb

@@ -1,6 +1,7 @@
 require_relative './persistence_base'
 require_relative './collection'
 require_relative './file_datastream'
+require_relative './data_serializer'
 
 class CommonRepositoryModel::Data < CommonRepositoryModel::PersistenceBase
   belongs_to(
@@ -18,8 +19,7 @@ class CommonRepositoryModel::Data < CommonRepositoryModel::PersistenceBase
     m.field :slot_name, :string
     m.field :md5_checksum, :string
   end
-  delegate :slot_name, unique: true, to: :properties
-  delegate :md5_checksum, unique: true, to: :properties
+  delegate_to :properties, [:slot_name, :md5_checksum], unique: true
   validates :slot_name, presence: true
 
   def content=(file)

data/lib/common_repository_model/data_serializer.rb

@@ -0,0 +1,5 @@
+require_relative './persistence_base_serializer'
+class CommonRepositoryModel::DataSerializer < CommonRepositoryModel::PersistenceBaseSerializer
+  attributes :slot_name, :md5_checksum
+  has_one :collection, embed: :ids
+end

data/lib/common_repository_model/persistence_base.rb

@@ -1,8 +1,24 @@
 require 'active_fedora'
+require 'active_model_serializers'
+require_relative './persistence_base_serializer'
 module CommonRepositoryModel
   class ObjectNotFoundError < ActiveFedora::ObjectNotFoundError
   end
 
   class PersistenceBase < ActiveFedora::Base
+    include ActiveModel::SerializerSupport
+    def active_model_serializer
+      "#{self.class}Serializer".constantize
+    end
+
+    class_attribute :attributes_for_json
+    self.attributes_for_json = []
+
+    def self.register_attribute(attribute_name, options = {})
+      delegate(attribute_name, options)
+      self.attributes_for_json ||= []
+      self.attributes_for_json += [attribute_name]
+    end
+
   end
 end

data/lib/common_repository_model/persistence_base_serializer.rb

@@ -0,0 +1,6 @@
+require 'active_model/serializer'
+module CommonRepositoryModel
+  class PersistenceBaseSerializer < ActiveModel::Serializer
+    attribute :pid
+  end
+end

data/lib/common_repository_model/railtie.rb

@@ -3,5 +3,10 @@ module CommonRepositoryModel
     rake_tasks do
       load "tasks/common_repository_model.tasks"
     end
+    generators do
+      require(
+        'generators/common_repository_model/collection/collection_generator'
+      )
+    end
   end
-end
+end

data/lib/common_repository_model/test_support.rb

@@ -0,0 +1,19 @@
+module CommonRepositoryModel
+  module TestSupport
+    def with_persisted_area(name = nil)
+      options = {}
+      options[:name] = name if name
+      area = FactoryGirl.create(:common_repository_model_area, options)
+      yield(area)
+    ensure
+      area.delete if area
+    end
+  end
+end
+require 'factory_girl'
+['collection','area','data'].each do |name|
+  begin
+    require_relative "../../spec/factories/common_repository_model/#{name}_factory"
+  rescue FactoryGirl::DuplicateDefinitionError
+  end
+end

data/lib/common_repository_model/version.rb

@@ -1,3 +1,3 @@
 module CommonRepositoryModel
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/generators/common_repository_model/collection/USAGE

@@ -1,9 +1,12 @@
 Description:
-  This generator provides a means of creating a service
+  This generator provides a means of creating a collection
 
 Example:
-  rails generate service ChickenPieService
+  rails generate common_repository_model:collection ChickenPie
 
   This will create:
-    app/services/chicken_pie_service.rb
-    spec/services/chicken_pie_service_spec.rb
+    app/repository_models/chicken_pie.rb
+    app/repository_serializers/chicken_pie_serializer.rb
+    spec/repository_models/chicken_pie_spec.rb
+    spec/repository_serializers/chicken_pie_serializer.rb
+    spec/factories/chicken_pie_factory.rb

data/lib/generators/common_repository_model/collection/collection_generator.rb

@@ -1,6 +1,9 @@
 require 'rails/generators'
-class CommonRepositoryModel::Collection < Rails::Generators::NamedBase
+
+class CommonRepositoryModel::CollectionGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('../templates', __FILE__)
+  argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+  class_option :test_dir, :type => :string, :default => "spec/factories", :desc => "The directory where the factories should go"
 
   def create_collection
     template(
@@ -8,10 +11,30 @@ class CommonRepositoryModel::Collection < Rails::Generators::NamedBase
       File.join('app/repository_models/', "#{file_name}.rb")
     )
   end
+
   def create_service_spec
     template(
       'collection_spec.rb.erb',
       File.join('spec/repository_models/', "#{file_name}_spec.rb")
     )
   end
+
+  def create_fixture_file
+    template 'collection_factory.rb.erb', File.join(options[:test_dir], "#{file_name}_factory.rb")
+  end
+
+  def create_serializer
+    template(
+      'collection_serializer.rb.erb',
+      File.join('app/repository_serializers/', "#{file_name}_serializer.rb")
+    )
+  end
+
+  def create_serializer_spec
+    template(
+      'collection_serializer_spec.rb.erb',
+      File.join('spec/repository_serializers/', "#{file_name}_serializer_spec.rb")
+    )
+  end
+
 end

data/lib/generators/common_repository_model/collection/templates/collection_factory.rb.erb

@@ -0,0 +1,13 @@
+# Generated via
+#  `rails generate common_repository_model::collection <%= class_name %>`
+#
+# Read about factories at https://github.com/thoughtbot/factory_girl
+
+require 'common_repository_model/test_support'
+FactoryGirl.define do
+  factory :<%= singular_table_name %>, class: <%= class_name %> do
+<% for attribute in attributes -%>
+    <%= attribute.name %> <%= attribute.default.inspect %>
+<% end -%>
+  end
+end

data/lib/generators/common_repository_model/collection/templates/collection_serializer.rb.erb

@@ -0,0 +1,9 @@
+# Generated via
+#  `rails generate common_repository_model::collection <%= class_name %>`
+
+require 'common_repository_model/collection_serializer'
+class <%= class_name %>Serializer < CommonRepositoryModel::CollectionSerializer
+  # You already will have the area (PID); See corresponding spec
+  #
+  # https://github.com/rails-api/active_model_serializers
+end

data/lib/generators/common_repository_model/collection/templates/collection_serializer_spec.rb.erb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe <%= class_name %>Serializer do
+  subject { <%= class_name %>Serializer.new(<%= singular_table_name %>) }
+  let(:<%= singular_table_name %>) { FactoryGirl.build(:<%= singular_table_name %>) }
+  let(:json) { JSON.parse(subject.to_json) }
+  let(:root) { json.fetch('<%= singular_table_name %>') }
+  it 'should be JSON' do
+    root.fetch('pid')
+    root.fetch('area').should == <%= singular_table_name %>.area.pid
+  end
+end

data/lib/generators/common_repository_model/collection/templates/collection_spec.rb.erb

@@ -1,4 +1,9 @@
-require_relative '../spec_helper'
+# Generated via
+#  `rails generate common_repository_model::collection <%= class_name %>`
+require 'spec_helper'
+require 'common_repository_model/test_support'
 
 describe <%= class_name %> do
+  include CommonRepositoryModel::TestSupport
+  subject { FactoryGirl.build(:<% singular_table_name %>) }
 end

data/spec/common_respository_model/area_serializer_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../spec_helper'
+require 'common_repository_model/area_serializer'
+
+describe CommonRepositoryModel::AreaSerializer do
+  subject { CommonRepositoryModel::AreaSerializer.new(area) }
+  let(:area) { CommonRepositoryModel::Area.new(name: 'hello') }
+  let(:json) { JSON.parse(subject.to_json) }
+  let(:root) { json.fetch('area') }
+  it 'should be JSON' do
+    root.fetch('pid')
+    root.fetch('name').must_equal area.name
+  end
+end

data/spec/common_respository_model/area_spec.rb

@@ -4,7 +4,7 @@ require 'common_repository_model/collection'
 
 describe CommonRepositoryModel::Area do
   describe 'without persisting' do
-    subject { FactoryGirl.build(:area, name: name) }
+    subject { FactoryGirl.build(:common_repository_model_area, name: name) }
     let(:name) { 'My Area Name'}
 
     it 'should find or create by #name' do
@@ -30,7 +30,7 @@ describe CommonRepositoryModel::Area do
   end
 
   describe 'integration (with persistence)' do
-    let(:collection) { FactoryGirl.build(:collection, area: nil) }
+    let(:collection) { FactoryGirl.build(:common_repository_model_collection, area: nil) }
     it 'should .find_by_name and .find_by_name!' do
       with_persisted_area do |area|
         CommonRepositoryModel::Area.find_by_name(area.name).must_equal area

data/spec/common_respository_model/collection_serializer_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../spec_helper'
+require 'common_repository_model/collection_serializer'
+
+describe CommonRepositoryModel::CollectionSerializer do
+  subject { CommonRepositoryModel::CollectionSerializer.new(collection) }
+  let(:collection) {
+    FactoryGirl.build(:common_repository_model_collection)
+  }
+  let(:json) { JSON.parse(subject.to_json) }
+  let(:root) { json.fetch('collection') }
+  it 'should be JSON' do
+    root.fetch('pid')
+    root.fetch('area').must_equal collection.area.pid
+  end
+end

data/spec/common_respository_model/collection_spec.rb

@@ -2,9 +2,22 @@ require_relative '../spec_helper'
 require 'common_repository_model/collection'
 
 describe CommonRepositoryModel::Collection do
-  subject { FactoryGirl.build(:collection) }
+  subject { FactoryGirl.build(:common_repository_model_collection) }
+
+  it 'should have an #area_name' do
+    subject.respond_to?(:area_name)
+  end
+
+  it 'should have #named_area_finder' do
+    lambda {
+      subject.named_area_finder.call('NEVER-GONNA_EXIST')
+    }.must_raise CommonRepositoryModel::ObjectNotFoundError
+  end
+
   it 'should require an area' do
     with_persisted_area do |area|
+      subject.named_area_finder.call(area.name)
+
       subject.area = area
       subject.area.must_be_kind_of(CommonRepositoryModel::Area)
       subject.valid?.must_equal true
@@ -47,7 +60,9 @@ describe CommonRepositoryModel::Collection do
 
 
   describe 'integration' do
-    let(:child_collection) { FactoryGirl.build(:collection, area: nil) }
+    let(:child_collection) {
+      FactoryGirl.build(:common_repository_model_collection, area: nil)
+    }
     it 'should keep a child collection in the parent collection' do
       with_persisted_area do |area_1|
         with_persisted_area do |area_2|

data/spec/common_respository_model/data_serializer_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../spec_helper'
+require 'common_repository_model/data_serializer'
+
+describe CommonRepositoryModel::DataSerializer do
+  subject { CommonRepositoryModel::DataSerializer.new(data) }
+  let(:data) { FactoryGirl.build(:common_repository_model_data) }
+  let(:json) { JSON.parse(subject.to_json) }
+  let(:root) { json.fetch('data') }
+  it 'should be JSON' do
+    root.fetch('pid')
+    root.fetch('slot_name').must_equal data.slot_name
+    root.fetch('md5_checksum').must_equal data.md5_checksum
+    root.fetch('collection').must_equal data.collection.pid
+  end
+end

data/spec/common_respository_model/data_spec.rb

@@ -2,10 +2,10 @@ require_relative '../spec_helper'
 require 'common_repository_model/data'
 
 describe CommonRepositoryModel::Data do
-  subject { FactoryGirl.build(:data) }
+  subject { FactoryGirl.build(:common_repository_model_data) }
 
   describe 'integration' do
-    let(:collection) { FactoryGirl.build(:collection) }
+    let(:collection) { FactoryGirl.build(:common_repository_model_collection) }
     let(:file_1) { File.new(__FILE__) }
     let(:file_2) {
       File.new(File.join(File.dirname(__FILE__), '../spec_helper.rb'))
@@ -13,13 +13,13 @@ describe CommonRepositoryModel::Data do
 
     it 'should have #slot_name' do
       subject.must_respond_to :slot_name
-      subject.must_respond_to :slot_name=
-        end
+      subject.must_respond_to(:slot_name=)
+    end
 
     it 'should have #md5_checksum' do
-      subject.must_respond_to :md5_checksum
-      subject.must_respond_to :md5_checksum=
-        end
+      subject.must_respond_to( :md5_checksum)
+      subject.must_respond_to(:md5_checksum=)
+    end
 
     it 'should have content versions' do
       subject.content = file_1

data/spec/common_respository_model/integration_spec.rb

@@ -56,7 +56,7 @@ describe CommonRepositoryModel::Collection do
   after(:each) do
     area.delete if area.persisted?
   end
-  let(:area) { FactoryGirl.create(:area) }
+  let(:area) { FactoryGirl.create(:common_repository_model_area) }
   let(:family) { Family.new(area: area) }
   let(:lawyer) { Job.new(area: area) }
   let(:doctor) { Job.new(area: area) }

data/spec/common_respository_model/persistence_base_serializer_spec.rb

@@ -0,0 +1,12 @@
+require_relative '../spec_helper'
+require 'common_repository_model/persistence_base_serializer'
+
+describe CommonRepositoryModel::PersistenceBaseSerializer do
+  subject { CommonRepositoryModel::PersistenceBaseSerializer.new(base) }
+  let(:base) { CommonRepositoryModel::PersistenceBase.new }
+  let(:json) { JSON.parse(subject.to_json) }
+  let(:root) { json.fetch('persistence_base') }
+  it 'should be JSON with a PID' do
+    root.fetch('pid')
+  end
+end

data/spec/common_respository_model/test_support_spec.rb

@@ -0,0 +1,12 @@
+# This is a spec that should not include the spec_helper. It is to be used by
+# other applications.
+require 'minitest/autorun'
+require_relative '../../lib/common_repository_model/test_support'
+
+describe CommonRepositoryModel::TestSupport do
+  describe 'area' do
+    subject { FactoryGirl.build(:common_repository_model_area) }
+    it { subject.must_be_instance_of CommonRepositoryModel::Area }
+    it { subject.valid?.must_equal true }
+  end
+end

data/spec/factories/common_repository_model/area_factory.rb

@@ -0,0 +1,8 @@
+require_relative '../../../lib/common_repository_model/area'
+
+FactoryGirl.define do
+  factory :common_repository_model_area, class: CommonRepositoryModel::Area do
+    sequence(:name) { |n| "Area-#{n}" }
+    to_create { |instance| instance.send(:save!) }
+  end
+end