hydra-editor 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79829b582cd67317fe3dd9ca93973022d5faf33f
-  data.tar.gz: 800b69b756b5029c4b4cce692f2cc80fcc0a384d
+  metadata.gz: 7d4df6ff1905911d18d55cf3a29f90110ed2e9f6
+  data.tar.gz: 6fe5727b88830e9bffdeb14def5086b424a879c6
 SHA512:
-  metadata.gz: ffb00e067dd04edaec73fd812c96a91cfbbda411a65964abc4bda920a5fa5780bfcbfdaf34cf3dcbd4611d2cd3f8c3c08195dbd16ce2bb40c409c1efc060599c
-  data.tar.gz: d3f8175ab883da5c33469042958b7ae017a415d0c0a11e6599e4c1ad04a25477c47d4e06175ecc0dcaaf14c1eb66d1c4ef01daf13a9f997073b8a06383039e2a
+  metadata.gz: eea2175ee9783b6da57c28fe8ba8bb74ede02a8bf324a5f7e2c3770755e5472a01e49f6b2783e2483b07958b9a8ab9038693d9fd46d855152bcee411cfa2abad
+  data.tar.gz: c3ae9b2431484a4c62c5b8302614ab587ebd3e56c0e55baf6f181015dc3b9e07031e0b07bcba4c520e197e2be20b20c62d452888284dd3d208dac4ee08a686ca

data/History.md

@@ -0,0 +1,11 @@
+# History of hydra-editor releases
+
+## 0.0.2
+* Requiring active-fedora >= 6.3.0 in order to have the .required? method on ActiveFedora::Base:q
+
+## 0.1.0
+* RecordsControllerBehavior made more easily reusable outside of RecordsController.
+
+### 0.1.1
+* Correctly account for modifications made by initialize_fields when processing form data. Fixes #14.
+

data/README.md

@@ -1,4 +1,5 @@
-# HydraEditor [![Gem Version](https://badge.fury.io/rb/hydra-editor.png)](http://badge.fury.io/rb/hydra-editor)
+# HydraEditor [![Gem Version](https://badge.fury.io/rb/hydra-editor.png)](http://badge.fury.io/rb/hydra-editor) [![Build Status](https://travis-ci.org/projecthydra/hydra-editor.png)](https://travis-ci.org/projecthydra/hydra-editor)
+
 
 To use add to your gemfile:
 

data/Rakefile

@@ -35,27 +35,20 @@ desc "Generate the dummy app"
 task :setup do
   unless File.exists?("#{dummy}/Rakefile")
     `rails new #{dummy}`
-    `cp -r spec/support/Gemfile #{dummy}/`
     `cp -r spec/support/lib/generators #{dummy}/lib`
     Dir.chdir(dummy) do
-      sh "rails g blacklight --devise"
-      sh "rails g hydra:head -f"
-      sh "rm spec/models/user_spec.rb" # generated by devise
-      puts "Generating test app"
+      puts "Generating test app ..."
       sh "rails generate test_app"
-      puts "running migrations"
-      sh 'rake db:migrate db:test:prepare'
-	  sh "touch public/test.html" # for spec/features/record_editing_spec.rb
+	    sh "touch public/test.html"      # for spec/features/record_editing_spec.rb
     end
   end
 end
 
-desc "Run the spec tests"
-task :spec => :setup do
-  here = File.expand_path("../", __FILE__)
-  Dir.chdir(dummy) do
-    Bundler.with_clean_env do
-      sh "bundle exec rspec --color -I#{here}/spec #{here}/spec"
-    end
-  end
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec => :setup) do |t|
+  t.pattern =  'spec/**/*_spec.rb'
 end
+
+
+task :default => :spec

data/app/controllers/concerns/records_controller_behavior.rb

@@ -1,18 +1,24 @@
 module RecordsControllerBehavior
   extend ActiveSupport::Concern
-  
+
   included do
-    before_filter :load_and_authorize_record, only: [:edit, :update]
-  end
+    load_and_authorize_resource only: [:new, :edit, :update, :create], instance_name: resource_instance_name
 
-  def new
-    authorize! :create, ActiveFedora::Base
-    unless has_valid_type?
+    rescue_from HydraEditor::InvalidType do
       render 'records/choose_type'
-      return
     end
+  end
 
-    @record = params[:type].constantize.new
+  module ClassMethods
+    def cancan_resource_class
+      HydraEditor::ControllerResource
+    end
+    def resource_instance_name
+      name.sub("Controller", "").underscore.split('/').last.singularize
+    end
+  end
+
+  def new
     initialize_fields
     render 'records/new'
   end
@@ -23,23 +29,15 @@ module RecordsControllerBehavior
   end
 
   def create
-    authorize! :create, ActiveFedora::Base
-    unless has_valid_type?
-      redirect_to(respond_to?(:hydra_editor) ? hydra_editor.new_record_path : new_record_path, flash: {error: "Lost the type"})
-      return
-    end
-    @record = params[:type].constantize.new
     set_attributes
 
     respond_to do |format|
-      if @record.save
+      if resource.save
         format.html { redirect_to redirect_after_create, notice: 'Object was successfully created.' }
-        # ActiveFedora::Base#to_json causes a circular reference.  Do something easy
-        data = @record.terms_for_editing.inject({}) { |h,term|  h[term] = @record[term]; h } 
-        format.json { render json: data, status: :created, location: redirect_after_create }
+        format.json { render json: object_as_json, status: :created, location: redirect_after_create }
       else
         format.html { render action: "new" }
-        format.json { render json: @record.errors, status: :unprocessable_entity }
+        format.json { render json: resource.errors, status: :unprocessable_entity }
       end
     end
 
@@ -48,50 +46,44 @@ module RecordsControllerBehavior
   def update
     set_attributes
     respond_to do |format|
-      if @record.save
+      if resource.save
         format.html { redirect_to redirect_after_update, notice: 'Object was successfully updated.' }
         format.json { head :no_content }
       else
         format.html { render action: "edit" }
-        format.json { render json: @record.errors, status: :unprocessable_entity }
+        format.json { render json: resource.errors, status: :unprocessable_entity }
       end
     end
   end
 
   protected
 
-  def load_and_authorize_record
-    load_record
-    authorize_record!
-  end
-
-  def load_record
-    @record = ActiveFedora::Base.find(params[:id], cast: true)
-  end
-
-  def authorize_record!
-    authorize! params[:action].to_sym, @record
+  def object_as_json 
+    # ActiveFedora::Base#to_json causes a circular reference (before 7.0).  Do something easy
+    resource.terms_for_editing.each_with_object({}) { |term, h|  h[term] = resource[term] } 
   end
 
   # Override this method if you want to set different metadata on the object
   def set_attributes
-    @record.attributes = collect_form_attributes
+    resource.attributes = collect_form_attributes
   end
 
   def collect_form_attributes
-    attributes = params[ActiveModel::Naming.singular(@record)]
+    raw_attributes = params[ActiveModel::Naming.singular(resource)]
+    # we could probably do this with strong parameters if the gemspec depends on Rails 4+
+    permitted_attributes = resource.terms_for_editing.each_with_object({}) { |key, attrs| attrs[key] = raw_attributes[key] if raw_attributes[key] }
     # removes attributes that were only changed by initialize_fields
-    attributes.reject { |key, value| @record[key].empty? and value == [""] }
+    permitted_attributes.reject { |key, value| resource[key].empty? and value == [""] }
   end
 
   # Override to redirect to an alternate location after create
   def redirect_after_create
-    main_app.catalog_path @record
+    main_app.catalog_path resource
   end
 
   # Override to redirect to an alternate location after update
   def redirect_after_update
-    main_app.catalog_path @record
+    main_app.catalog_path resource
   end
 
   def has_valid_type?
@@ -99,9 +91,24 @@ module RecordsControllerBehavior
   end
 
   def initialize_fields
-    @record.terms_for_editing.each do |key|
+    resource.terms_for_editing.each do |key|
       # if value is empty, we create an one element array to loop over for output 
-      @record[key] = [''] if @record[key].empty?
+      resource[key] = [''] if resource[key].empty?
     end
   end
+
+  def resource
+    get_resource_ivar
+  end
+
+  # Get resource ivar based on the current resource controller.
+  #
+  def get_resource_ivar #:nodoc:
+    instance_variable_get("@#{resource_instance_name}")
+  end
+
+  def resource_instance_name
+    self.class.resource_instance_name
+  end
+
 end

data/config/routes.rb

@@ -1,4 +1,3 @@
 HydraEditor::Engine.routes.draw do
   resources :records, only: [:new, :edit, :create, :update], :constraints => { :id => /[a-zA-Z0-9_.:]+/ }
-
 end

data/lib/hydra-editor.rb

@@ -1,7 +1,15 @@
+require "cancan"
 require "hydra_editor/engine"
 require "bootstrap_forms"
 
 module HydraEditor
+
+  class InvalidType < RuntimeError; end
+
+  extend ActiveSupport::Autoload
+
+  autoload :ControllerResource
+
   def self.models= val
     @models = val
   end
@@ -9,4 +17,8 @@ module HydraEditor
   def self.models
     @models ||= []
   end
+
+  def self.valid_model?(type)
+    models.include? type
+  end
 end

data/lib/hydra_editor/controller_resource.rb

@@ -0,0 +1,18 @@
+class HydraEditor::ControllerResource < CanCan::ControllerResource
+  def find_resource
+    ActiveFedora::Base.find(id_param, cast: true)
+  end
+
+  def resource_class
+    raise HydraEditor::InvalidType, "Lost the type" unless has_valid_type?
+    type_param.constantize
+  end
+
+  def has_valid_type?
+    HydraEditor.valid_model? type_param
+  end
+
+  def type_param
+    @params[:type]
+  end
+end

data/lib/hydra_editor/engine.rb

@@ -1,8 +1,10 @@
 module HydraEditor
   class Engine < ::Rails::Engine
     engine_name 'hydra_editor'
-    config.paths.add "app/helpers/concerns",      eager_load: true
-    config.paths.add "app/controllers/concerns",  eager_load: true
-    config.paths.add "app/models/concerns",       eager_load: true
+    config.autoload_paths += %W(
+       #{config.root}/app/helpers/concerns
+       #{config.root}/app/controllers/concerns
+       #{config.root}/app/models/concerns
+    )
   end
 end

data/lib/hydra_editor/version.rb

@@ -1,3 +1,3 @@
 module HydraEditor
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hydra-editor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Coyne
+- David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,21 +88,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -115,7 +102,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: blacklight
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -156,9 +143,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A basic Dublin Core metadata editor for hydra-head
+description: A basic metadata editor for hydra-head
 email:
-- justin@curationexperts.com
+- hydra-tech@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -182,11 +169,13 @@ files:
 - config/locales/hydra_editor.yml
 - config/routes.rb
 - lib/hydra-editor.rb
+- lib/hydra_editor/controller_resource.rb
 - lib/hydra_editor/engine.rb
 - lib/hydra_editor/version.rb
 - lib/tasks/hydra-editor_tasks.rake
 - Rakefile
 - README.md
+- History.md
 homepage: http://github.com/projecthydra/hydra-editor
 licenses: []
 metadata: {}
@@ -206,8 +195,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: A basic Dublin Core metadata editor for hydra-head
+summary: A basic metadata editor for hydra-head
 test_files: []