formal_wear 0.0.1

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-pro

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jacob Stetser
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# FormalWear
+
+[![Build Status](https://travis-ci.org/wideopenspaces/formal_wear.png)](https://travis-ci.org/wideopenspaces/formal_wear.png) [![Code Climate](https://codeclimate.com/github/wideopenspaces/formal_wear.png)](https://codeclimate.com/github/wideopenspaces/formal_wear) [![Coverage Status](https://coveralls.io/repos/wideopenspaces/formal_wear/badge.png)](https://coveralls.io/r/wideopenspaces/formal_wear)
+
+"You're going to like the way you look. I guarantee it."
+
+FormalWear helps you create Form Objects with required and optional attributes and gets all fancy widdit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'formal_wear'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formal_wear
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/formal_wear.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/formal_wear/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jake Stetser"]
+  gem.email         = ["jake@wideopenspac.es"]
+  gem.description   = %q{FormalWear helps you create Form Objects with required and optional attributes and gets all fancy widdit.}
+  gem.summary       = %q{You're going to like the way you look. I guarantee it.}
+  gem.homepage      = "https://github.com/wideopenspaces/formal_wear"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "formal_wear"
+  gem.require_paths = ["lib"]
+  gem.version       = FormalWear::VERSION
+
+  gem.add_dependency 'activesupport', '>= 3.0.20'
+  gem.add_dependency 'hash_assertions', '~> 0.1.0'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'mocha', '~> 0.13.1'
+  gem.add_development_dependency 'coveralls'
+end

data/lib/formal_wear/class_methods.rb

@@ -0,0 +1,24 @@
+module FormalWear
+  module ClassMethods
+    def required_attrs(attrs)
+      validate_attrs!(attrs)
+
+      required = class_variable_get(:@@required_fields) || {}
+      class_variable_set(:@@required_fields, required.merge(attrs))
+
+      create_accessors(attrs.keys)
+    end
+    def required_attr(a); required_attrs(a); end
+
+    def create_accessors(keys)
+      keys.each { |k| self.send(:attr_accessor, k) unless method_defined?(k) }
+    end
+
+    def validate_attrs!(attrs)
+      attrs.each do |a, opts|
+        opts.assert_valid_keys(*ALLOWED_KEYS)
+        opts.assert_required_keys(*REQUIRED_KEYS)
+      end
+    end
+  end
+end

data/lib/formal_wear/instance_methods.rb

@@ -0,0 +1,107 @@
+module FormalWear
+  module InstanceMethods
+    ### THE NITTY GRITTY STARTS HERE
+
+    # Start the configuration process
+    def initialize(primary)
+      @primary = primary
+      update_sources
+    end
+
+    def required_attributes
+      required_fields.dup.each do |field, options|
+        options.slice!(:name, :type)
+      end
+    end
+
+    # Return the list of required fields for this configurator
+    def required_fields
+      @@required_fields
+    end
+
+    def required_fields_without_custom_stores
+      required_fields.reject { |f,o| custom_store?(o) }
+    end
+
+    def required_fields_with_custom_stores
+      required_fields.select { |f,o| custom_store?(o) }
+    end
+
+    def to_h
+      {}.merge(required_attributes: required_attributes).tap do |h|
+        required_fields.keys.each { |k| h[k] = self.send(k) }
+      end
+    end
+
+    def update(attrs)
+      raise ArgumentError, "update requires a Hash"
+      attrs.each do |field, value|
+        self.send(:"#{field}=", value) if instance_method_defined?(field)
+      end
+    end
+
+    def valid?
+      required_fields.keys.all? { |k| self.send(k).present? }
+    end
+
+    def save
+      return false unless valid?
+      saving do
+        required_fields.each { |field, options| set_field(field, options) }
+      end
+    end
+
+    private
+
+    # Redefine this in a configurator if you need to do anything before you save the data
+    def before_save
+    end
+
+    # Redefine this in a configurator in order to run tasks after completing setup
+    def after_save
+    end
+
+    def saving(&block)
+      before_save
+      yield if block_given?
+      after_save
+    end
+
+    def set_field(field, options)
+      custom_store?(options) ? set_via_custom_store(field, options) : self.send(:"set_#{field}")
+    end
+
+    def set_via_custom_store(field, options)
+      return set_via_symbol(options) if symbol_store?(options)
+      return set_via_lambda(field, options) if lambda_store?(options)
+    end
+
+    def set_via_symbol(options)
+      self.send(options[:store])
+    end
+
+    def set_via_lambda(field, options)
+      callable = options[:store]
+      self.instance_eval(&callable)
+    end
+
+    def custom_store?(options)
+      options[:store].present?
+    end
+
+    def symbol_store?(options)
+      custom_store?(options) && options[:store].is_a?(Symbol)
+    end
+
+    def lambda_store?(options)
+      custom_store?(options) && options[:store].try(:lambda?)
+    end
+
+    # When donning formal_wear, pre-populate from source if available
+    def update_sources
+      required_fields.each do |field, options|
+        send(:"#{field}=", options[:source].call(self)) if options[:source] rescue nil
+      end
+    end
+  end
+end

data/lib/formal_wear/version.rb

@@ -0,0 +1,3 @@
+module FormalWear
+  VERSION = "0.0.1"
+end

data/lib/formal_wear.rb

@@ -0,0 +1,22 @@
+require 'formal_wear/version'
+require 'formal_wear/class_methods'
+require 'formal_wear/instance_methods'
+require 'hash_assertions'
+require 'active_support/core_ext'
+require 'active_support/concern'
+
+module FormalWear
+  extend ActiveSupport::Concern
+
+  ### CLASS LEVEL BEHAVIOR
+  REQUIRED_KEYS = [:name, :type, :source]
+  ALLOWED_KEYS  = REQUIRED_KEYS | [:store, :select_options]
+
+  included do
+    extend FormalWear::ClassMethods
+    include FormalWear::InstanceMethods
+
+    attr_reader :primary
+    cattr_reader :required_fields
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.mock_with :mocha
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/test_formal_wear.rb

@@ -0,0 +1,69 @@
+require 'formal_wear'
+
+class TestFormalWear
+  include FormalWear
+
+  required_attr moms_id: {
+    name: "Your mom's id",
+    type: :text,
+    source: ->(s) { s.primary.thing_to_be_configured },
+  }
+
+  required_attr docs_id: {
+    name: "Your doc's id",
+    type: :text,
+    source: ->(s) { s.primary.dependent_object.another_thing_to_be_configured },
+    store: :set_my_docs_id
+  }
+
+  required_attr lambda_lambda_lambda: {
+    name: 'Revenge Of The Nerds!',
+    type: :text,
+    source: ->(s) { s.get_pledged },
+    store:  ->(s) { s.got_lambda? }
+  }
+
+  protected
+
+  def after_save
+    # no-op
+  end
+
+  def set_moms_id
+    # no-op
+  end
+
+  def set_my_docs_id
+    # no-op
+  end
+
+  def got_lambda?
+    # no-op
+  end
+
+  def get_pledged
+    primary.dependent_object.another_thing_to_be_configured
+  end
+end
+
+class ExternalObjectOne
+  attr_accessor :thing_to_be_configured, :dependent_object
+
+  def initialize(initial_value, initial_subvalue)
+    @thing_to_be_configured = initial_value
+    @dependent_object = ExternalObjectTwo.new(initial_subvalue)
+  end
+
+end
+
+class ExternalObjectTwo
+  attr_accessor :another_thing_to_be_configured
+
+  def initialize(initial_value)
+    @another_thing_to_be_configured = initial_value
+  end
+
+  def yet_another_thing_to_be_configured
+    "Stuff"
+  end
+end

data/spec/test_formal_wear_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+require 'test_formal_wear'
+
+describe TestFormalWear do
+  let(:primary) { ExternalObjectOne.new(nil, nil)}
+  let(:config) { TestFormalWear.new(primary) }
+
+  describe 'a configurator with completed setup' do
+    let(:ready_primary) { ExternalObjectOne.new('Formal', 'Wear') }
+    let(:ready_config) { TestFormalWear.new(ready_primary)  }
+
+    subject { ready_config }
+
+    context 'when initialized' do
+      describe '#moms_id' do
+        it 'is equal to ExternalObjectOne.thing_to_be_configured' do
+          subject.moms_id.should == subject.primary.thing_to_be_configured
+        end
+      end
+
+      describe '#docs_id' do
+        it 'is equal to ExternalObjectTwo.another_thing_to_be_configured' do
+          subject.docs_id.should == subject.primary.dependent_object.another_thing_to_be_configured
+        end
+      end
+    end
+  end
+
+  describe 'a new configurator object' do
+    subject { config }
+
+    it 'has a required_fields method' do
+      subject.should respond_to(:required_fields)
+    end
+
+    describe '#required_fields' do
+      subject { config.required_fields }
+      it { should be_a(Hash) }
+
+      it 'contains the appropriate required fields' do
+        subject.keys.should =~ [:moms_id, :docs_id, :lambda_lambda_lambda]
+      end
+    end
+
+    it 'has a valid? method' do
+      subject.should respond_to(:valid?)
+    end
+
+    it 'has a getter method for each of the required fields' do
+      subject.required_fields.keys.each do |k|
+        subject.should respond_to(k)
+      end
+    end
+
+    it 'has a setter method for each of the required fields' do
+      subject.required_fields.keys.each do |k|
+        subject.should respond_to(:"#{k}=")
+      end
+    end
+
+    context 'when a required field has a "store" key' do
+      context 'that is a symbol' do
+        it 'responds to a method corresponding to that symbol' do
+          subject.should respond_to(subject.required_fields[:docs_id][:store])
+        end
+      end
+    end
+
+    context 'when a required field does not have a "store" key' do
+      it 'responds to a set_xxx method for each required field' do
+        config.required_fields_without_custom_stores.each do |field, options|
+          subject.should respond_to(:"set_#{field}")
+        end
+      end
+    end
+  end
+
+  describe '#valid?' do
+    subject { config }
+
+    context 'when none of the required fields are set' do
+      before do
+        config.moms_id = nil
+      end
+
+      it 'returns false' do
+        config.valid?.should be_false
+      end
+    end
+
+    context 'when not all of the required fields are set' do
+      before do
+        config.moms_id = 'zztop'
+      end
+
+      it 'returns false' do
+        config.valid?.should be_false
+      end
+    end
+
+    context 'when all of the required fields are set' do
+      before do
+        config.moms_id = config.docs_id = config.lambda_lambda_lambda = '1'
+      end
+
+      it 'returns true' do
+        config.valid?.should be_true
+      end
+    end
+  end
+
+  describe '#save' do
+    subject { config }
+
+    context 'when not valid?' do
+      it 'returns false' do
+        subject.save.should be_false
+      end
+    end
+
+    context 'when valid?' do
+      before do
+        subject.moms_id = subject.docs_id = subject.lambda_lambda_lambda = '1'
+        subject.required_fields_without_custom_stores.keys.each do |k|
+          subject.expects("set_#{k}").returns(true)
+        end
+
+        subject.required_fields_with_custom_stores.each do |field, opt|
+          if opt[:store].is_a?(Symbol)
+            subject.expects(opt[:store]).returns(true)
+            subject.expects(:"set_#{field}").never
+          elsif opt[:store].try(:lambda?)
+           subject.expects(:got_lambda?).returns(true)
+          end
+        end
+
+        subject.expects(:after_save).returns(true)
+      end
+
+      it 'calls the set_xxx methods for each required field' do
+        subject.save
+      end
+
+      it 'calls #after_save' do
+        # condition met by expectation above
+        subject.save
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: formal_wear
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jake Stetser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.20
+- !ruby/object:Gem::Dependency
+  name: hash_assertions
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: FormalWear helps you create Form Objects with required and optional attributes
+  and gets all fancy widdit.
+email:
+- jake@wideopenspac.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- formal_wear.gemspec
+- lib/formal_wear.rb
+- lib/formal_wear/class_methods.rb
+- lib/formal_wear/instance_methods.rb
+- lib/formal_wear/version.rb
+- spec/spec_helper.rb
+- spec/test_formal_wear.rb
+- spec/test_formal_wear_spec.rb
+homepage: https://github.com/wideopenspaces/formal_wear
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: You're going to like the way you look. I guarantee it.
+test_files:
+- spec/spec_helper.rb
+- spec/test_formal_wear.rb
+- spec/test_formal_wear_spec.rb