hydramata-works 0.0.1.prerelease

data/lib/hydramata/works/translator.rb

@@ -0,0 +1,67 @@
+require 'active_support/core_ext/array/wrap'
+
+module Hydramata
+  module Works
+    # Responsible for handling the translation via diminishing specificity
+    class Translator
+
+      class << self
+        def translate(key, options = {})
+          new(options).translate(key, options)
+        end
+        alias_method :t, :translate
+      end
+
+      attr_reader :base_scope, :translation_service, :translation_service_error
+      def initialize(options = {})
+        self.base_scope = options.fetch(:base_scope) { default_base_scope }
+        @translation_service = options.fetch(:translation_service) { default_translation_service }
+        @translation_service_error = options.fetch(:translation_service_error) { default_translation_service_error }
+      end
+
+      def translate(key, options = {})
+        translate_key_for_specific_scopes(key, options) || translate_key_for_general_case(key, options)
+      end
+      alias_method :t, :translate
+
+      private
+
+      def translate_key_for_specific_scopes(key, options = {})
+        return nil unless scopes = options[:scopes]
+        returning_value = nil
+        Array.wrap(scopes).each do |scope|
+          begin
+            returning_value = translation_service.translate(key, scope: base_scope + Array.wrap(scope),raise: true)
+            break
+          rescue *translation_service_error
+            next
+          end
+        end
+        returning_value
+      end
+
+      def translate_key_for_general_case(key, options = {})
+        options[:scope] = base_scope
+        translation_service.translate(key, options)
+      end
+
+      def base_scope=(values)
+        @base_scope = Array.wrap(values)
+      end
+
+      def default_base_scope
+        ['hydramata', 'work']
+      end
+
+      def default_translation_service_error
+        require 'i18n/exceptions'
+        I18n::ArgumentError
+      end
+
+      def default_translation_service
+        require 'i18n'
+        I18n
+      end
+    end
+  end
+end

data/lib/hydramata/works/version.rb

@@ -0,0 +1,5 @@
+module Hydramata
+  module Works
+    VERSION = '0.0.1.prerelease'
+  end
+end

data/lib/hydramata_works.rb

@@ -0,0 +1,2 @@
+# A convenience/courtesy file for adopters of this gem.
+require 'hydramata-works'

data/lib/tasks/hydramata_work_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :hydramata/work do
+#   # Task goes here
+# end

data/run_each_spec_in_isolation

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby -w
+require 'time'
+require 'rake'
+require 'benchmark'
+
+File.open("run_each_spec_in_isolation.txt", 'w+') do |file|
+  file.puts "Using Benchmark.measure.real\n"
+  FileList['spec/**/*_spec.rb'].sort.select do |fn|
+    puts "rspec #{fn}"
+    measurement = Benchmark.measure { system "rspec #{fn}" }
+    file.puts format("%#.1f\t%s", (measurement.real), fn)
+    file.puts ''
+  end
+  measurement = Benchmark.measure { system('rspec') }
+  file.puts format("%#.1f\t%s", (measurement.real), "total-time-for-specs-run-together")
+end

data/run_each_spec_in_isolation.txt

@@ -0,0 +1,110 @@
+Using Benchmark.measure.real
+6.5	spec/features/fedora_to_in_memory_spec.rb
+
+5.1	spec/features/format_and_view_path_overrides_spec.rb
+
+9.7	spec/features/in_memory_to_output_buffer_spec.rb
+
+2.6	spec/features/new_user_input_to_in_memory_spec.rb
+
+2.4	spec/features/translation_services_spec.rb
+
+3.1	spec/forms/hydramata/works/entity_form_spec.rb
+
+2.4	spec/forms/hydramata/works/validation_service_spec.rb
+
+1.6	spec/lib/hydramata-work_spec.rb
+
+2.2	spec/lib/hydramata/works/conversions/predicate_set_spec.rb
+
+2.6	spec/lib/hydramata/works/conversions/predicate_spec.rb
+
+2.4	spec/lib/hydramata/works/conversions/presented_fieldsets_spec.rb
+
+2.5	spec/lib/hydramata/works/conversions/property_set_spec.rb
+
+2.3	spec/lib/hydramata/works/conversions/property_spec.rb
+
+1.8	spec/lib/hydramata/works/conversions/translation_key_fragment_spec.rb
+
+2.0	spec/lib/hydramata/works/conversions/value_spec.rb
+
+2.4	spec/lib/hydramata/works/conversions/work_type_spec.rb
+
+1.6	spec/lib/hydramata/works/translator_spec.rb
+
+1.6	spec/models/hydramata/works/data_definition_spec.rb
+
+1.7	spec/models/hydramata/works/entities_spec.rb
+
+2.4	spec/models/hydramata/works/entity_spec.rb
+
+2.4	spec/models/hydramata/works/predicate_presentation_sequences/storage_spec.rb
+
+2.3	spec/models/hydramata/works/predicate_set_spec.rb
+
+2.3	spec/models/hydramata/works/predicate_sets/storage_spec.rb
+
+2.2	spec/models/hydramata/works/predicate_spec.rb
+
+2.3	spec/models/hydramata/works/predicates/storage_spec.rb
+
+2.2	spec/models/hydramata/works/predicates_spec.rb
+
+1.5	spec/models/hydramata/works/presentation_structure_spec.rb
+
+2.2	spec/models/hydramata/works/property_set_spec.rb
+
+2.4	spec/models/hydramata/works/property_spec.rb
+
+1.5	spec/models/hydramata/works/value_spec.rb
+
+2.2	spec/models/hydramata/works/work_type_spec.rb
+
+2.3	spec/models/hydramata/works/work_types/storage_spec.rb
+
+4.7	spec/models/hydramata/works/work_types_spec.rb
+
+2.7	spec/parsers/hydramata/works/datastream_parser_spec.rb
+
+3.3	spec/parsers/hydramata/works/datastream_parsers/rdf_ntriples_parser_spec.rb
+
+1.6	spec/parsers/hydramata/works/datastream_parsers/simple_xml_parser_spec.rb
+
+1.7	spec/parsers/hydramata/works/predicate_parser_spec.rb
+
+1.6	spec/parsers/hydramata/works/predicate_parsers/simple_parser_spec.rb
+
+1.5	spec/parsers/hydramata/works/value_parser_spec.rb
+
+1.5	spec/parsers/hydramata/works/value_parsers/simple_parser_spec.rb
+
+1.6	spec/parsers/hydramata/works/value_parsers_spec.rb
+
+1.7	spec/presenters/hydramata/works/base_presenter_spec.rb
+
+2.3	spec/presenters/hydramata/works/entity_presenter_spec.rb
+
+1.6	spec/presenters/hydramata/works/fieldset_presenter_spec.rb
+
+1.5	spec/presenters/hydramata/works/property_presenter_spec.rb
+
+1.5	spec/renderers/hydramata/works/entity_renderer_spec.rb
+
+2.4	spec/views/hydramata/works/fieldsets/_edit.html.erb_spec.rb
+
+2.4	spec/views/hydramata/works/fieldsets/_show.html.erb_spec.rb
+
+2.4	spec/views/hydramata/works/properties/_edit.html.erb_spec.rb
+
+2.4	spec/views/hydramata/works/properties/_show.html.erb_spec.rb
+
+2.4	spec/views/hydramata/works/works/_edit.html.erb_spec.rb
+
+2.4	spec/views/hydramata/works/works/_new.html.erb_spec.rb
+
+2.4	spec/views/hydramata/works/works/_show.html.erb_spec.rb
+
+1.5	spec/wranglers/hydramata/works/fedora_wrangler_spec.rb
+
+7.5	total-time-for-specs-run-together

data/script/analyzer.rb

@@ -0,0 +1,124 @@
+#!/usr/local/bin/ruby
+
+require 'pp'
+require 'sexp_processor'
+require 'ruby_parser'
+require 'byebug'
+require 'rake'
+require 'set'
+
+class Collector
+  attr_reader :namespace
+  def initialize(namespace)
+    @namespace = namespace
+    @storage = {}
+  end
+
+  def push(class_stack, collaborator)
+    klass = register(class_stack)
+    @storage[klass] << collaborator
+  end
+
+  def register(class_stack)
+    klass = class_stack.reverse[0..-1].collect(&:to_s).join('::')
+    @storage[klass] ||= Set.new
+    klass
+  end
+
+  def render
+    puts %(digraph "G" {)
+    puts %(    label="#{namespace}") if namespace
+    @storage.each do |klass, collaborators|
+      if klass.strip != '' || collaborators.any? {|c| c =~ /\A#{namespace}/ }
+        puts render_node(klass)
+        collaborators.each do |collaborator|
+          if @storage.detect do |some_class, _|
+              if some_class =~ /\A#{namespace}(::\w+)*::#{collaborator}\Z/
+                render_node(some_class)
+                render_edge(klass, some_class)
+                true
+              else
+                false
+              end
+            end
+          else
+            if collaborator =~ /\A#{namespace}/
+              render_node(collaborator)
+              render_edge(klass, collaborator)
+            end
+          end
+        end
+      end
+    end
+    puts %(})
+  end
+
+  def render_node(klass)
+    puts %(    #{to_dot_name(klass)}[label="#{klass}"])
+  end
+
+  def render_edge(from, to)
+    puts %(    #{to_dot_name(from)} -> #{to_dot_name(to)})
+  end
+
+  def to_dot_name(str)
+    str.gsub(/[\W:]+/,'_')
+  end
+end
+
+class DependencyAnalyzer < MethodBasedSexpProcessor
+
+  attr_reader :collector
+
+  def initialize(collector = Collector.new)
+    super()
+    @collector = collector
+  end
+
+  def process_colon2(exp)
+    klass = classify_colon2(exp).join("::")
+    collector.push(class_stack, klass)
+    return exp
+  end
+
+  def process_module(exp)
+    super(exp)
+    collector.register(class_stack)
+    return exp
+  end
+
+  def process_dfn(exp)
+    collector.register(class_stack)
+    return exp
+  end
+
+  def process_const(exp)
+    collaborator = exp[1]
+    collector.push(class_stack, collaborator.to_s)
+    return s(:const, collaborator)
+  end
+
+  def classify_colon2(exp, returning = [])
+    returning.unshift(exp[2]) if exp[2]
+    if exp[1].is_a?(Sexp)
+      classify_colon2(exp[1], returning)
+    else
+      returning.unshift(exp[1])
+    end
+    return returning
+  end
+
+end
+
+if __FILE__ == $0
+  collaborator = Collector.new('Hydramata::Works')
+  analyzer = DependencyAnalyzer.new(collaborator)
+  FileList['app/**/*.rb', 'lib/**/*.rb'].each do |filename|
+  # filename = '/Users/jfriesen/Repositories/hydramata-work/app/parsers/hydramata/works/predicate_parsers/simple_parser.rb'
+    file_content = File.read(filename)
+    parsed_file = RubyParser.for_current_ruby.parse(file_content)
+    # break
+    analyzer.process(parsed_file)
+  end
+  collaborator.render
+end

data/script/fast_specs

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby -w
+
+require 'rake'
+
+# A helper function for answering: Does this spec run fast?
+module Fast
+  module_function
+  def spec?(fn)
+    open(fn) { |f| f.gets =~ /spec_fast_helper/ }
+  end
+end
+
+fast_specs = FileList['spec/**/*_spec.rb'].select do |fn|
+  Fast.spec?(fn)
+end
+
+if fast_specs.any?
+  system "rspec #{fast_specs}"
+else
+  puts 'Unable to find any fast specs'
+  exit(-1)
+end

data/spec/features/fedora_to_in_memory_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_slow_helper'
+require 'hydramata/works/fedora_wrangler'
+
+require 'vcr'
+require 'webmock'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/cassettes'
+  config.hook_into :webmock
+end
+
+# Because of Rubydora this is required
+def logger
+  @logger ||= Logger.new("/dev/null")
+end
+
+module Hydramata
+  module Works
+
+    describe 'An in Fedora object is loaded into an in memory work' do
+      let(:pid) { 'und:f4752f8687n' }
+      let(:work_wrangler) { FedoraWrangler.new(entity: entity) }
+      let(:entity) { Entity.new }
+
+      it 'should parse the Fedora object and assign the predicates' do
+        seed_predicates!
+        VCR.use_cassette('fedora-object', record: :none) do
+          work_wrangler.call(pid, with_datastreams: true)
+          expect { |b| entity.properties.each(&b) }.
+          to yield_successive_args(
+            Property.new(predicate: 'depositor', value: 'username-1'),
+            Property.new(predicate: 'http://purl.org/dc/terms/created', value: Date.new(2014, 6, 2)),
+            Property.new(predicate: 'http://purl.org/dc/terms/language', value: 'English'),
+            Property.new(predicate: 'http://purl.org/dc/terms/publisher', value: 'University of Notre Dame'),
+            Property.new(predicate: 'http://purl.org/dc/terms/title', value: 'Title 1'),
+            Property.new(predicate: 'http://purl.org/dc/terms/dateSubmitted', value: Date.new(2014, 6, 4)),
+            Property.new(predicate: 'http://purl.org/dc/terms/modified', value: Date.new(2014, 6, 3)),
+            Property.new(predicate: 'http://purl.org/dc/terms/rights', value: 'Attribution 3.0 United States'),
+            Property.new(predicate: 'http://purl.org/dc/terms/creator', value: 'Creator Name1'),
+            Property.new(predicate: 'http://purl.org/dc/terms/description', value: 'Hello World!')
+          )
+        end
+      end
+
+      def seed_predicates!
+        Predicates::Storage.delete_all
+        Predicates::Storage.create!(identity: 'depositor')
+        Predicates::Storage.create!(identity: 'http://purl.org/dc/terms/created', value_parser_name: 'DateParser')
+        Predicates::Storage.create!(identity: 'http://purl.org/dc/terms/language', value_parser_name: 'InterrogationParser' )
+        Predicates::Storage.create!(identity: 'http://purl.org/dc/terms/publisher', value_parser_name: 'InterrogationParser')
+        Predicates::Storage.create!(identity: 'http://purl.org/dc/terms/title', value_parser_name: 'InterrogationParser')
+        Predicates::Storage.create!(identity: 'http://purl.org/dc/terms/dateSubmitted', value_parser_name: 'DateParser')
+        Predicates::Storage.create!(identity: 'http://purl.org/dc/terms/modified', value_parser_name: 'DateParser')
+        Predicates::Storage.create!(identity: 'http://purl.org/dc/terms/rights', value_parser_name: 'InterrogationParser')
+        Predicates::Storage.create!(identity: 'http://purl.org/dc/terms/creator', value_parser_name: 'InterrogationParser')
+        Predicates::Storage.create!(identity: 'http://purl.org/dc/terms/description', value_parser_name: 'InterrogationParser')
+      end
+    end
+  end
+end

data/spec/features/format_and_view_path_overrides_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_slow_helper'
+
+# This spec verifies that the Entity -> Fieldset -> Properties render chain
+# uses the same presentation context for the entire render process.
+module Hydramata
+  module Works
+    describe 'An entity and presentation structure' do
+      context 'with view_path override and format' do
+        it 'uses the found views instead of the defaults' do
+          rendered_output = renderer.render
+          expect(rendered_output.strip).to eq("ENTITY article\nFIELDSET required\nPROPERTY title")
+        end
+
+        around do |example|
+          begin
+            generate_template(
+              'works',
+              "ENTITY <%= #{presentation_context}.t(:work_type)%>",
+              "<% #{presentation_context}.fieldsets.each do |f|%><%= f.render(template: self) %><% end %>"
+            )
+            generate_template(
+              'fieldsets',
+              "FIELDSET <%= #{presentation_context}.t(:name)%>",
+              "<% #{presentation_context}.each do |f|%><%= f.render(template: self) %><% end %>"
+            )
+            generate_template('properties', "PROPERTY <%= #{presentation_context}.t(:name) %>")
+            example.run
+          ensure
+            cleanup_template('works')
+            cleanup_template('fieldsets')
+            cleanup_template('properties')
+          end
+        end
+
+      end
+
+      def generate_template(name, *lines)
+        path = File.expand_path("../../../#{view_path}/hydramata/works/#{name}/_#{presentation_context}.#{format}.erb", __FILE__)
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, 'w+') { |f| f.puts lines.join("\n") }
+      end
+
+      def cleanup_template(name)
+        path = File.expand_path("../../../#{view_path}/hydramata/works/#{name}/_#{presentation_context}.#{format}.erb", __FILE__)
+        File.unlink(path) if File.exist?(path)
+      end
+
+      let(:entity) do
+        Entity.new do |entity|
+          entity.work_type = 'article'
+          entity.properties << { predicate: :title, value: 'Hello' }
+        end
+      end
+
+      let(:presentation_structure) do
+        PresentationStructure.new.tap do |struct|
+          struct.fieldsets << [:required, [:title]]
+        end
+      end
+
+      let(:presentation_context) { :nonsense }
+      let(:view_path) { 'app/views/articles' }
+      let(:format) { :elvis }
+
+      let(:entity_presenter) do
+        EntityPresenter.new(entity: entity, presentation_structure: presentation_structure, presentation_context: presentation_context)
+      end
+
+      let(:renderer) { EntityRenderer.new(entity: entity_presenter, format: format, view_path: view_path) }
+    end
+  end
+end