consensus 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDVjNDRhNGQwNTQ1YjBlNWJiZTU1YmNmOTYyNWJlYjUxNjhiYmQ0Mg==
+  data.tar.gz: !binary |-
+    MDY2NzRlZjMyMGU2YmNhNjYyYTQ3YjIzMTYyYjQ2NzNlNzdkZWVlMw==
+SHA512:
+  metadata.gz: !binary |-
+    NDYyYWM0ZGRjMzE1YzExMDZiMTlkNzM3YTcyZGY4YzY2NTE2MDYzMGU3MjM0
+    NTI3OGYzMGI4MGQyMDgwMmY1ZTE2YjYyNTI0Y2IyMWE1OTcwZDQ4NDZiNDJm
+    ODVlZjBmMjJlNzc5MDlmMDBlMDVlMWRlNjczODBiM2I0Y2JlZGI=
+  data.tar.gz: !binary |-
+    Nzc5MmMwYjI4ZjAzYjc2NGM2ZGVlMTZlNzU5Y2NmMTUwMmUyYTI5MTIxYjhh
+    Nzc2OWRkMWUzODlhM2Q4NGY5NTI1NWI5MTQyYTcyMGU5NTFmYWI4YTI4ZGI3
+    MzI0NDdkODE2OGQ3YzkxMTM5NDBmMGVjZjU3YTdlMmE1NmRhMWQ=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-version
+.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 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Steve Jorgensen
+
+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,76 @@
+# Consensus
+
+The purpose of this gem is to facilitate the construction of Ruby
+programs with robust, high-value tests through the creation of
+data classes with specific APIs that are used both in production
+and as test doubles in tests.
+
+A problem that frequently arises when testing code in a dynamic
+language such as Ruby is that there is nothing to ensure that
+the APIs of test double objects (mocks and stubs) implemnt the
+same APIs as the objects that will be given to the code under test
+and that this remains true as the code changes over time.
+
+That situation can be improved through the use of simple struct-
+like objects to pass data around, but those objects can be a poor
+fit in many cases such as a view model that exposes data that will
+not necessarily be consumed and is costly to produce.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'consensus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install consensus
+
+## Usage
+
+Declare a new class that extends Consensus::Portrayal and define
+one or more portrayal attributes using the "attribute" class
+method.
+
+    class Data < Consensus::Portrayal
+      attribute :name, :points, :admin?
+    end
+
+Assign simple values or callable objects to attributes of an
+instance of the class.
+
+    class UserFetcher
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def user_data
+        data = Data.new
+        data.name   = name
+        data.points = ->{ user_record.points }
+        admin       = ->{ user_record.admin? }
+        return data
+      end
+
+      private
+
+      def user_record
+        User.where(name: name).first
+      end
+    end
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/consensus/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/consensus.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'consensus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "consensus"
+  spec.version       = Consensus::VERSION
+  spec.authors       = ["Steve Jorgensen"]
+  spec.email         = ["stevej@stevej.name"]
+  spec.summary       = %q{A data transfer object that can have lazy attributes.}
+  spec.description   = %q{A data transfer object that can have lazy attributes.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/consensus/portrayal.rb

@@ -0,0 +1,30 @@
+module Consensus
+  class Portrayal
+
+    class << self
+
+      def attribute(*names)
+        names.each do |n| ; define_attribute(n) ; end
+      end
+
+      private
+
+      def define_attribute name
+        base_name = name.to_s.sub(/\?$/, '')
+        attr_writer base_name
+
+        class_eval <<-EOS, __FILE__, __LINE__ + 1
+          def #{name}
+            if @#{base_name}.respond_to?(:call)
+              @#{base_name} = @#{base_name}.call
+            else
+              @#{base_name}
+            end
+          end
+        EOS
+      end
+
+    end
+
+  end
+end

data/lib/consensus/version.rb

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

data/lib/consensus.rb

@@ -0,0 +1,5 @@
+require "consensus/version"
+require "consensus/portrayal"
+
+module Consensus
+end

data/spec/consensus/portrayal_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Consensus::Portrayal do
+  describe '.attribute' do
+    let(:instance){ klass.new }
+
+    describe "given a simple attribute name" do
+      let(:klass){ Class.new(described_class) do
+        attribute :the_attribute
+      end }
+
+      it "defines the named settable/gettable attribute" do
+        instance.the_attribute = :some_value
+        expect( instance.the_attribute ).to eq(:some_value)
+      end
+    end
+
+    describe "given a name ending in \"?\"" do
+      let(:klass){ Class.new(described_class) do
+        attribute :ya_think?
+      end }
+
+      it "defines a non-\"?\" setter with a \"?\" getter" do
+        instance.ya_think = :yes_i_do
+        expect( instance.ya_think? ).to eq(:yes_i_do)
+      end
+    end
+
+    describe "given multiple attribute names" do
+      let(:klass){ Class.new(described_class) do
+        attribute :a1, :a2, :a3
+      end }
+
+      it "defines all of the named attributes" do
+        i = instance
+        i.a1, i.a2, i.a3 = 1, 2, 3
+        expect( [i.a1, i.a2, i.a3] ).to eq( [1, 2, 3] )
+      end
+    end
+  end
+
+  describe "an instance attribute defined using .attribute" do
+    subject{ klass.new }
+    let(:klass){ Class.new(described_class) do
+      attribute :an_attribute
+    end }
+
+    describe "when assigned a callable object" do
+      let(:callable){ double(:callable) }
+
+      before do
+        subject.an_attribute = callable
+      end
+
+      it "gets the result of #call on the assigned object" do
+        allow( callable ).to receive(:call).and_return :call_result
+        expect( subject.an_attribute ).to eq( :call_result )
+      end
+
+      it "reuses the previous #call result for subsequent gets" do
+        expect( callable ).to receive(:call).once.and_return :call_result
+        expect( subject.an_attribute ).to eq( :call_result )
+        expect( subject.an_attribute ).to eq( :call_result )
+      end
+    end
+  end
+end

data/spec/consensus_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Consensus do
+  it 'should have a version number' do
+    Consensus::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'consensus'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: consensus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steve Jorgensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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 data transfer object that can have lazy attributes.
+email:
+- stevej@stevej.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- consensus.gemspec
+- lib/consensus.rb
+- lib/consensus/portrayal.rb
+- lib/consensus/version.rb
+- spec/consensus/portrayal_spec.rb
+- spec/consensus_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A data transfer object that can have lazy attributes.
+test_files:
+- spec/consensus/portrayal_spec.rb
+- spec/consensus_spec.rb
+- spec/spec_helper.rb