rails_view_adapters 0.2.1

data/spec/lib/map_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+module RailsViewAdapters
+
+  class TestMap < Map
+    def to_hash
+      {
+        model_fields: model_fields,
+        public_fields: public_fields,
+        simple_maps: simple_maps,
+        to_maps: to_maps,
+        from_maps: from_maps
+      }
+    end
+  end
+
+  describe Map do
+    let(:map) { TestMap.new }
+    let(:bare_hash) do
+      {
+        model_fields: [],
+        public_fields: [],
+        simple_maps: [],
+        to_maps: [],
+        from_maps: []
+      }
+    end
+
+    describe "#add_model_field" do
+      let(:model_field) { :test123 }
+      it "adds the model field" do
+        map.add_model_field(model_field)
+        expect(map.to_hash).to eql(bare_hash.merge(model_fields: [model_field]))
+      end
+      it "returns self" do
+        expect(map.add_model_field(model_field)).to be(map)
+      end
+    end
+
+    describe "#add_public_field" do
+      let(:public_field) { :test123 }
+      it "adds the model field" do
+        map.add_public_field(public_field)
+        expect(map.to_hash).to eql(bare_hash.merge(public_fields: [public_field]))
+      end
+      it "returns self" do
+        expect(map.add_public_field(public_field)).to be(map)
+      end
+    end
+
+    describe "#add_simple_map" do
+      let(:public_field) { :pub }
+      let(:model_field) { :mod }
+      it "adds the simple mapping" do
+        map.add_simple_map(model_field, public_field)
+        expect(map.to_hash).to eql(bare_hash.merge(
+          public_fields: [public_field],
+          model_fields: [model_field],
+          simple_maps: [[model_field, public_field]]
+        ))
+      end
+      it "returns self" do
+        expect(map.add_simple_map(model_field, public_field)).to be(map)
+      end
+    end
+
+    describe "#add_to_map" do
+      let(:model_field) { :mod }
+      let(:process) { proc {|v| v + 37 } }
+      it "adds the mapping" do
+        map.add_to_map(model_field, &process)
+        expect(map.to_hash).to eql(bare_hash.merge(
+          model_fields: [model_field],
+          to_maps: [[model_field, process]]
+        ))
+      end
+      it "returns self" do
+        expect(map.add_to_map(model_field, &process)).to be(map)
+      end
+    end
+
+    describe "#add_from_map" do
+      let(:public_field) { :pub }
+      let(:process) { proc {|v| v + 37 } }
+      it "adds the mapping" do
+        map.add_from_map(public_field, &process)
+        expect(map.to_hash).to eql(bare_hash.merge(
+          public_fields: [public_field],
+          from_maps: [[public_field, process]]
+        ))
+      end
+      it "returns self" do
+        expect(map.add_from_map(public_field, &process)).to be(map)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+
+# frozen_string_literal: true
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # config.order = :random
+  # Kernel.srand config.seed
+end
+
+require "rails_view_adapters"
+Dir[File.join(File.dirname(__FILE__), "support", "**", "*.rb")].each {|f| require f }

data/spec/support/an_adapter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+# You should define these:
+# let(:model)
+# let(:public_hash)
+# let(:model_hash)
+
+shared_examples "an adapter" do |hidden_params|
+  hidden_params ||= {}
+  describe ".from_model" do
+    it "can be created from a model" do
+      expect do
+        adapter_class.from_model(model)
+      end.to_not raise_error
+    end
+  end
+
+  describe ".from_public" do
+    it "can be created from a model" do
+      expect do
+        adapter_class.from_public(public_hash)
+      end.to_not raise_error
+    end
+    it "handles missing data" do
+      expect do
+        adapter_class.from_public({})
+      end.to_not raise_error
+    end
+  end
+
+  context "starting with .from_public" do
+    let(:adapter) do
+      adapter_class.from_public(public_hash.merge(unrelated: :unchanged).merge(hidden_params))
+    end
+    include_examples "adapter output", unrelated: :unchanged
+  end
+
+  context "starting with .from_model" do
+    let(:adapter) { adapter_class.from_model(model) }
+    include_examples "adapter output", {}
+  end
+end
+
+shared_examples "adapter output" do |params_extra|
+  describe "#to_model_hash" do
+    it "creates the proper hash" do
+      expect(adapter.to_model_hash).to fuzzy_nested_match(model_hash)
+    end
+    it "removes extra fields" do
+      expect(adapter.to_model_hash.keys.sort).to match_array(model_hash.keys.sort)
+    end
+  end
+
+  describe "#to_public_hash" do
+    it "creates the proper hash" do
+      expect(adapter.to_public_hash).to fuzzy_nested_match(public_hash)
+    end
+    it "removes extra fields" do
+      expect(adapter.to_public_hash.keys.sort).to match_array(public_hash.keys.sort)
+    end
+  end
+
+  describe "#to_params_hash" do
+    it "creates the proper hash" do
+      expect(adapter.to_params_hash).to fuzzy_nested_match(model_hash.merge(params_extra))
+    end
+  end
+end

data/spec/support/fuzzy_nested_match.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+module Matchers
+  class FuzzyNestedMatcher
+    def initialize(expected)
+      @expected = expected
+      @errors = nil
+    end
+
+    def matches?(actual)
+      @errors ||= match(actual, @expected)
+      @errors.nil?
+    end
+
+    def match_primitives(actual, expected)
+      "expected #{expected}, got #{actual}" unless actual == expected
+    end
+
+    def match_times(actual, expected)
+      diff = actual - expected
+      "expected #{expected}, got #{actual}" unless diff.between?(-1, 1)
+    end
+
+    def match_hashes(actual, expected)
+      unless actual.keys.sort == expected.keys.sort
+        extra = (actual.keys - expected.keys).map {|key| "+#{key}" }
+        missing = (expected.keys - actual.keys).map {|key| "-#{key}" }
+        return { "Hash keys mismatch:" => extra + missing }
+      end
+
+      errors = {}
+      actual.keys.each do |key|
+        error = match(actual[key], expected[key])
+        errors[key] = error if error
+      end
+
+      errors.empty? ? nil : errors
+    end
+
+    def match_arrays(actual, expected)
+      unless actual.size == expected.size
+        return "Actual size #{actual.size}, expected #{expected.size}"
+      end
+      errors = []
+      actual.each_index do |i|
+        error = match(actual[i], expected[i])
+        errors[i] = error if error
+      end
+      errors.empty? ? nil : errors
+    end
+
+    def match_active_records(actual, expected)
+      match_hashes(actual.attributes.except(:id), expected.attributes.except(:id))
+    end
+
+    def match(actual, expected)
+      actual_responds_to = responders(actual)
+      expected_responds_to = responders(expected)
+      unless actual_responds_to == expected_responds_to
+        return "Type mismatch: expected [#{expected_responds_to}], got [#{actual_responds_to}]"
+      end
+      if actual_responds_to.include? :push
+        return match_arrays(actual, expected)
+      elsif actual_responds_to.include? :has_key?
+        return match_hashes(actual, expected)
+      elsif actual.is_a? ActiveRecord::Base
+        return match_active_records(actual, expected)
+      elsif actual.respond_to? :strftime
+        return match_times(actual, expected)
+      else
+        return match_primitives(actual, expected)
+      end
+    end
+
+    def responders(obj)
+      responds_to = []
+      [:each, :push, :has_key?].each do |method|
+        responds_to << method if obj.respond_to? method
+      end
+      responds_to
+    end
+
+    def failure_message
+      @errors
+    end
+
+  end
+end
+
+def fuzzy_nested_match(actual)
+  Matchers::FuzzyNestedMatcher.new(actual)
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: rails_view_adapters
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Bryan Hockey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec-rails
+  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: faker
+  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: fabrication
+  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: pry
+  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: rubocop
+  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'
+description: Bidirectional mappings between models and external views for Rails.
+email:
+- bhock@umich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/rails_view_adapters.rb
+- lib/rails_view_adapters/adapter.rb
+- lib/rails_view_adapters/adapter_base.rb
+- lib/rails_view_adapters/definition_proxy.rb
+- lib/rails_view_adapters/map.rb
+- lib/rails_view_adapters/version.rb
+- rails_view_adapters.gemspec
+- spec/active_record_helper.rb
+- spec/active_record_support/db/migrate/20161031222934_create_users.rb
+- spec/active_record_support/db/migrate/20161031223219_create_posts.rb
+- spec/active_record_support/db/migrate/20161031223253_create_teams.rb
+- spec/active_record_support/fabricators/post_fabricator.rb
+- spec/active_record_support/fabricators/team_fabricator.rb
+- spec/active_record_support/fabricators/user_fabricator.rb
+- spec/active_record_support/models/post.rb
+- spec/active_record_support/models/team.rb
+- spec/active_record_support/models/user.rb
+- spec/integration/an_adapter_spec.rb
+- spec/lib/adapter_base_spec.rb
+- spec/lib/adapter_spec.rb
+- spec/lib/definition_proxy_spec.rb
+- spec/lib/map_spec.rb
+- spec/spec_helper.rb
+- spec/support/an_adapter.rb
+- spec/support/fuzzy_nested_match.rb
+homepage: https://github.com/mlibrary/rails_view_adapters
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Bidirectional mappings between models and external views for Rails.
+test_files:
+- spec/active_record_support/models/post.rb
+- spec/active_record_support/models/team.rb
+- spec/active_record_support/models/user.rb
+- spec/active_record_support/db/migrate/20161031223219_create_posts.rb
+- spec/active_record_support/db/migrate/20161031223253_create_teams.rb
+- spec/active_record_support/db/migrate/20161031222934_create_users.rb
+- spec/active_record_support/fabricators/user_fabricator.rb
+- spec/active_record_support/fabricators/post_fabricator.rb
+- spec/active_record_support/fabricators/team_fabricator.rb
+- spec/spec_helper.rb
+- spec/lib/adapter_base_spec.rb
+- spec/lib/definition_proxy_spec.rb
+- spec/lib/adapter_spec.rb
+- spec/lib/map_spec.rb
+- spec/active_record_helper.rb
+- spec/support/an_adapter.rb
+- spec/support/fuzzy_nested_match.rb
+- spec/integration/an_adapter_spec.rb