milan 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e495557a7c841ae2b80f98130286565076a40365
+  data.tar.gz: 2dd216aa489c491d2920bb633bf5c8c73fa5d09d
+SHA512:
+  metadata.gz: d1bbf28e1321b43db4cb79f03b3c71d1d600d4962dcb0676019aa9f557f5a8fba8c6058f4b79b356ff83b99a2f8808d48df05867ad6d8a05bae7b7279b7252ea
+  data.tar.gz: 2ad7f09d29fb91554fd7f05be5dde3313b4a8f82ef8a4d6432a09ffe928fe2229638c28bd078c30fbb385a3412866c423c308930eccdac37f3b6780149d9538e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in milan.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+##########################################################################
+# Copyright 2016 University of Notre Dame
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.md

@@ -0,0 +1,3 @@
+# Milan
+
+A model builder through configuration files.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "milan"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/milan.rb

@@ -0,0 +1,5 @@
+require "milan/version"
+
+module Milan
+  # Your code goes here...
+end

data/lib/milan/form_builder.rb

@@ -0,0 +1,45 @@
+require 'hanami/utils/string'
+require 'milan/term_aggregator'
+
+module Milan
+  class FormBuilder
+    def initialize(config:, term_aggregate_builder: default_term_aggregate_builder, &configuration_block)
+      self.config = config
+      self.name = config.fetch(:form)
+      self.partial_suffix = config.fetch(:partial_suffix, name)
+      self.term_aggregator = default_term_aggregate_builder.call(terms: config.fetch(:terms))
+      instance_exec(&configuration_block) if block_given?
+    end
+    attr_reader :name, :partial_suffix
+
+    extend Forwardable
+    def_delegator :term_aggregator, :append_additional_terms_configurations
+
+    def contracts
+      config.fetch(:contracts)
+    end
+
+    private
+
+    attr_writer :name
+    attr_accessor :config, :term_aggregator
+
+    def partial_suffix=(input)
+      @partial_suffix = Hanami::Utils::String.new(input).underscore
+    end
+
+    def default_term_aggregate_builder
+      Milan::TermAggregator.method(:new)
+    end
+  end
+
+  def self.form_for(work_type:, form:, config:)
+    work_types = config.fetch(:work_types)
+    work_type_config = work_types.find { |types| types.fetch(:work_type) }
+    form_config = work_type_config.fetch(:forms).find { |obj| obj.fetch(:form) == form }
+    FormBuilder.new(config: form_config) do
+      append_additional_terms_configurations(terms: work_type_config.fetch(:terms)) if form_config.key?(:terms)
+      append_additional_terms_configurations(terms: config.fetch(:terms)) if config.key?(:terms)
+    end
+  end
+end

data/lib/milan/term_aggregator.rb

@@ -0,0 +1,38 @@
+module Milan
+  # Responsible for aggregating the configuration information for the given terms
+  class TermAggregator
+    def initialize(terms:)
+      self.terms = terms
+      self.additional_terms_configurations = []
+    end
+
+    def append_additional_terms_configurations(terms:)
+      additional_terms_configurations << terms
+    end
+
+    def finalize
+      terms.each_with_object({}) do |term, obj|
+        obj[term.fetch(:term)] = build_configuration_for(term: term)
+        obj
+      end.freeze
+    end
+
+    private
+
+    attr_accessor :terms, :additional_terms_configurations
+
+    def build_configuration_for(term:)
+      key = term.fetch(:term)
+      aggregate_config = [term]
+      additional_terms_configurations.each do |terms_config|
+        additional_config = terms_config.find { |term_config| term_config.fetch(:term) == key }
+        next unless additional_config
+        aggregate_config.unshift(additional_config)
+      end
+      aggregate_config.each_with_object({}) do |element, hash|
+        hash.merge!(element)
+        hash
+      end
+    end
+  end
+end

data/lib/milan/version.rb

@@ -0,0 +1,3 @@
+module Milan
+  VERSION = "0.0.1.pre"
+end

data/milan.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'milan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "milan"
+  spec.version       = Milan::VERSION
+  spec.authors       = ["Jeremy Friesen"]
+  spec.email         = ["jeremy.n.friesen@gmail.com"]
+
+  spec.summary       = %q{A library for building models via a configuration.}
+  spec.description   = %q{A library for building models via a configuration.}
+  spec.homepage      = "https://github.com/jeremyf/milan"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hanami-utils", "~> 0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rspec-its"
+end

data/spec/features/form_builder_feature_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'milan/form_builder'
+
+RSpec.describe 'Form feature spec' do
+  context '.form_for' do
+    let(:context) { double('The Context for the Form') }
+    let(:requested_by) { double('Requester')}
+
+    subject { Milan.form_for(work_type: "ULRA Application", form: 'Plan of Study', config: config) }
+
+    its(:partial_suffix) { should eq('plan_of_study') }
+    it { should be_a(Milan::FormBuilder) }
+    its(:contracts) { should eq(config.fetch(:work_types)[0].fetch(:forms)[0].fetch(:contracts)) }
+  end
+
+  let(:config) do
+    {
+      work_types: [{
+        work_type: "ULRA Application",
+        contracts: [{
+          contexts: "ingest",
+          validations: [{ validator: 'Sipity::Contracts::IngestContract' }]
+        }],
+        forms: [{
+          form: "Plan of Study",
+          contracts: [{
+            contexts: ['submit'],
+            validations: [
+              { validates: 'ND.expected_graduation_term', presence: true, inclusion: "ND.expected_graduation_term/options" },
+              { validates: 'ND.underclass_level', presence: true, inclusion: "ND.underclass_level/options" },
+              { validates: 'ND.major', presence: true },
+              { validates: 'ND.primary_college', presence: true, cardinality: 1 }
+            ]
+          }],
+          terms: [
+            { term: 'ND.expected_graduation_term', cardinality: 1 },
+            { term: 'ND.underclass_level' },
+            { term: 'ND.major', cardinality: 'many' },
+            { term: 'ND.minor', cardinality: 'many' },
+            { term: 'ND.primary_college', cardinality: 1 }
+          ]
+        }],
+        terms: [{
+          term: 'ND.primary_college', cardinality: 1,
+          label: 'Primary College'
+        }]
+      }],
+      terms: [{
+        term: 'ND.underclass_level', options: ['First Year', 'Sophomore', 'Junior', 'Senior', '5th Year'], cardinality: 1
+      }]
+    }
+  end
+end

data/spec/lib/milan/form_builder_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'milan/form_builder'
+
+module Milan
+  RSpec.describe FormBuilder do
+    let(:config) { { form: 'hello', terms: { term: 'ND.another_term' } } }
+    let(:additional_terms) { { term: 'ND.expected_graduation_term', cardinality: 1 } }
+    subject { described_class.new(config: config) }
+    it 'will append terms to the term aggregator during initialization' do
+      expect_any_instance_of(TermAggregator).to receive(:append_additional_terms_configurations).with(additional_terms)
+      additional_terms_scoped = additional_terms # establishing lexical scope
+      described_class.new(config: config) do
+        append_additional_terms_configurations(additional_terms_scoped)
+      end
+    end
+  end
+end

data/spec/lib/milan/term_aggregator_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'milan/term_aggregator'
+
+module Milan
+  RSpec.describe TermAggregator do
+    subject { described_class.new(terms: [{ term: 'DC.title' }, { term: 'DC.abstract' }]) }
+
+    context '#finalize' do
+      subject { described_class.new(terms: [{ term: 'DC.title' }, { term: 'DC.abstract' }]).finalize }
+      context 'without additional term configuration' do
+        it { should be_a(Enumerable) }
+        its(:size) { should eq(2) }
+
+        it 'will expose retrieval method for term' do
+          expect(subject.fetch('DC.title')).to eq(term: 'DC.title')
+        end
+      end
+      context 'with additional configuration' do
+        subject do
+          described_class.new(terms: [{ term: 'DC.title' }, { term: 'DC.abstract', cardinality: 'many' }]).tap do |obj|
+            obj.append_additional_terms_configurations(
+              terms: [{ term: 'DC.title', cardinality: 1 }, { term: 'DC.hello' }, { term: 'DC.abstract', cardinality: 1}]
+            )
+          end.finalize
+        end
+
+        it { should be_a(Enumerable) }
+        its(:size) { should eq(2) }
+
+        it 'will expose retrieval method for term' do
+          expect(subject.fetch('DC.title')).to eq(term: 'DC.title', cardinality: 1)
+        end
+
+        it 'will prefer direct definitions of additional term configurations' do
+          expect(subject.fetch('DC.abstract')).to eq(term: 'DC.abstract', cardinality: 'many')
+        end
+
+        it 'will only register terms that were part of the initialization' do
+          expect { subject.fetch('DC.hello') }.to raise_error(KeyError)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec/its'

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: milan
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Jeremy Friesen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hanami-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: A library for building models via a configuration.
+email:
+- jeremy.n.friesen@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/milan.rb
+- lib/milan/form_builder.rb
+- lib/milan/term_aggregator.rb
+- lib/milan/version.rb
+- milan.gemspec
+- spec/features/form_builder_feature_spec.rb
+- spec/lib/milan/form_builder_spec.rb
+- spec/lib/milan/term_aggregator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jeremyf/milan
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: A library for building models via a configuration.
+test_files:
+- spec/features/form_builder_feature_spec.rb
+- spec/lib/milan/form_builder_spec.rb
+- spec/lib/milan/term_aggregator_spec.rb
+- spec/spec_helper.rb