renewable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 648680f8f5c0283aa11938e169a4ab509991221e
+  data.tar.gz: bbc9186b86c072cf0ece86692883486088325c62
+SHA512:
+  metadata.gz: 0cdab0882b58b0680062093a69723fcea91a86803a4ce7936bc0eeb42f37d51c97f8930e9a5fcc90ff3578500c351e33007e8c67cf9b0e438070482445736012
+  data.tar.gz: 9b64237e91316164f7dabc144e40f14f7e1e2b764d654ba22b4f16394f7170b1a37ed922da186fca65cebdf89e5964583183bac13162ce639161acd15d37a087

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+renewable

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.5

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.root(File.dirname(__FILE__))
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/.travis.yml

@@ -0,0 +1,75 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+  - jruby
+  - jruby-head
+jdk:
+  - openjdk6
+  - openjdk7
+  - oraclejdk7
+  - oraclejdk8
+branches:
+  only:
+    - master
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      jdk: openjdk6
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk8
+    - rvm: 2.0.0
+      jdk: openjdk6
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk8
+    - rvm: 2.1.0
+      jdk: openjdk6
+    - rvm: 2.1.0
+      jdk: oraclejdk7
+    - rvm: 2.1.0
+      jdk: oraclejdk8
+    - rvm: 2.1.1
+      jdk: openjdk6
+    - rvm: 2.1.1
+      jdk: oraclejdk7
+    - rvm: 2.1.1
+      jdk: oraclejdk8
+    - rvm: 2.1.2
+      jdk: openjdk6
+    - rvm: 2.1.2
+      jdk: oraclejdk7
+    - rvm: 2.1.2
+      jdk: oraclejdk8
+    - rvm: 2.1.3
+      jdk: openjdk6
+    - rvm: 2.1.3
+      jdk: oraclejdk7
+    - rvm: 2.1.3
+      jdk: oraclejdk8
+    - rvm: 2.1.4
+      jdk: openjdk6
+    - rvm: 2.1.4
+      jdk: oraclejdk7
+    - rvm: 2.1.4
+      jdk: oraclejdk8
+    - rvm: 2.1.5
+      jdk: openjdk6
+    - rvm: 2.1.5
+      jdk: oraclejdk7
+    - rvm: 2.1.5
+      jdk: oraclejdk8
+  allow_failures:
+    - rvm: jruby-head
+addons:
+  code_climate:
+    repo_token: 9e50ded77de130a89a7a427514be291a89485d1fb09e805aa384da81bc54a88d

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Thompson
+
+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,123 @@
+# Renewable
+
+[![Code Climate](https://codeclimate.com/github/plainprogrammer/renewable/badges/gpa.svg)](https://codeclimate.com/github/plainprogrammer/renewable)
+[![Build Status](https://travis-ci.org/plainprogrammer/renewable.svg)](https://travis-ci.org/plainprogrammer/renewable)
+[![Test Coverage](https://codeclimate.com/github/plainprogrammer/renewable/badges/coverage.svg)](https://codeclimate.com/github/plainprogrammer/renewable)
+
+Renewable provides means to have objects that are frozen by default. The benefit
+of this is that it pushes the developer in the direction of a more Functional
+style of programming that is safer in multi-threaded situations, but maintains
+many of the benefits of Object-Oriented Programming's binding of data and
+behavior by simply doing away with in-place mutation.
+
+## STATUS
+
+This code is still considered experimental in nature. It is not advised to use
+this library in production environments without having read and fully
+comprehended how the code works.
+
+*YOU HAVE BEEN WARNED!*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'renewable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install renewable
+
+## Usage
+
+Renewable exposes two usage approached: Mixin and Inheritance.
+
+```ruby
+class Person
+  include Renewable
+
+  attr_reader :name, :birth_date
+
+  def age
+    Date.today.year - birth_date.year
+  end
+end
+```
+
+```ruby
+class Person < Renewable::Object
+  attr_reader :name, :birth_date
+
+  def age
+    Date.today.year - birth_date.year
+  end
+end
+```
+
+Regardless of which you choose, the behavior is the same. Because of how
+Renewable is intended to function there are some important rules to follow when
+building your classes with Renewable.
+
+### Initializers
+
+*Don't write them!* Renewable implements an initializer that you can hook into
+via callbacks. Because of the steps that the initializer takes need to be
+preserved for everything to work properly you should simply avoid writing your
+own. All of the callbacks described below will receive an `attributes` and an
+`options` Hash, which are the two arguments the Renewable-supplied initializer
+expects. Callbacks should simply be defined as `protected` or `private` methods
+based on your inheritance needs.
+
+```ruby
+class Person < Renewable::Object
+  attr_reader :name, :birth_date
+
+  private
+
+  def process_arguments(attributes, options)
+    # This callback is invoked before Renewable does anything itself. So, do any
+    # custom manipulation or processing of the attributes and options hashes you
+    # need. This method should return an like so:
+    return attributes, options
+  end
+
+  def before_freeze(attributes, options)
+    # This callback is invoked immediately before Renewable freezes the object's
+    # state. Prior to this step Renewable places each item in `attributes` into
+    # its respective instance variable and stores `options` as well. This is
+    # your last chance to modify the object's internal state. This method should
+    # return like so:
+    return attributes, options
+  end
+
+  def after_freeze(attributes, options)
+    # This callback is invoked immediately after Renewable freezes the object's
+    # state. At this point you can no longer mutate the object, but this
+    # callback is provided just in case you find a use case. It is also the last
+    # thing invoked by Renewable's initialize implementation and thus requires
+    # no return value.
+  end
+end
+```
+
+### Mutators (Methods that change stuff)
+
+TODO: Write this section.
+
+### #renew
+
+TODO: Write this section.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/renewable/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 a 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/lib/renewable.rb

@@ -0,0 +1,52 @@
+require 'renewable/version'
+
+module Renewable
+  def initialize(attributes = {}, options = {})
+    attributes, options = process_arguments(attributes.dup, options.dup)
+    renewable_process_attributes(attributes)
+    renewable_process_options(options)
+    attributes, options = before_freeze(attributes, options)
+    self.freeze
+    after_freeze(attributes, options)
+  end
+
+  protected
+
+  # def renewable_attributes
+  #   @renwable_attributes
+  # end
+
+  # def renewable_options
+  #   @renwable_options
+  # end
+
+  private
+
+  def process_arguments(attributes, options)
+    return attributes, options
+  end
+
+  def renewable_process_attributes(attributes)
+    attributes.each do |name, value|
+      self.instance_variable_set(:"@#{name}", value)
+    end
+
+    #@renwable_attributes = attributes
+  end
+
+  def renewable_process_options(options)
+    #@renwable_options = options
+  end
+
+  def before_freeze(attributes, options)
+    return attributes, options
+  end
+
+  def after_freeze(attributes, options)
+    return attributes, options
+  end
+end
+
+class Renewable::Object
+  include ::Renewable
+end

data/lib/renewable/version.rb

@@ -0,0 +1,3 @@
+module Renewable
+  VERSION = '0.0.1'
+end

data/renewable.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'renewable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'renewable'
+  spec.version       = Renewable::VERSION
+  spec.authors       = ['James Thompson']
+  spec.email         = %w{james@buypd.com}
+  spec.summary       = %q{Provides frozen by default objects}
+  spec.description   = %q{Provides frozen by default objects for more Functional style.}
+  spec.homepage      = 'https://github.com/plainprogrammer/renewable'
+  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.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/spec/inhertitance_spec.rb

@@ -0,0 +1,37 @@
+require 'samples/inheritance_sample'
+
+RSpec.describe Renewable do
+  context 'used via inheritance' do
+    it 'initializes to a frozen object' do
+      expect(PersonA.new(birth_date: '1972-06-13').frozen?).to eq(true)
+    end
+
+    it 'assigns all attributes' do
+      person = PersonA.new(name: 'John',
+                          birth_date: '1972-06-13',
+                          hair_color: 'Brown')
+
+      expect(person.instance_variable_get(:@name)).to eq('John')
+      expect(person.instance_variable_get(:@birth_date)).to eq('1972-06-13')
+      expect(person.instance_variable_get(:@hair_color)).to eq('Brown')
+    end
+
+    it 'runs process_arguments callback' do
+      expect {
+        PersonA.new({}, {raise_process_arguments: true})
+      }.to raise_error(ArgumentError, 'entered process_arguments with raise option')
+    end
+
+    it 'runs before_freeze callback' do
+      expect {
+        PersonA.new({}, {raise_before_freeze: true})
+      }.to raise_error(ArgumentError, 'entered before_freeze with raise option')
+    end
+
+    it 'runs after_freeze callback' do
+      expect {
+        PersonA.new({}, {raise_after_freeze: true})
+      }.to raise_error(ArgumentError, 'entered after_freeze with raise option')
+    end
+  end
+end

data/spec/mixin_spec.rb

@@ -0,0 +1,37 @@
+require 'samples/mixin_sample'
+
+RSpec.describe Renewable do
+  context 'used as a mixin' do
+    it 'initializes to a frozen object' do
+      expect(PersonB.new(birth_date: '1972-06-13').frozen?).to eq(true)
+    end
+
+    it 'assigns all attributes' do
+      person = PersonB.new(name: 'John',
+                          birth_date: '1972-06-13',
+                          hair_color: 'Brown')
+
+      expect(person.instance_variable_get(:@name)).to eq('John')
+      expect(person.instance_variable_get(:@birth_date)).to eq('1972-06-13')
+      expect(person.instance_variable_get(:@hair_color)).to eq('Brown')
+    end
+
+    it 'runs process_arguments callback' do
+      expect {
+        PersonB.new({}, {raise_process_arguments: true})
+      }.to raise_error(ArgumentError, 'entered process_arguments with raise option')
+    end
+
+    it 'runs before_freeze callback' do
+      expect {
+        PersonB.new({}, {raise_before_freeze: true})
+      }.to raise_error(ArgumentError, 'entered before_freeze with raise option')
+    end
+
+    it 'runs after_freeze callback' do
+      expect {
+        PersonB.new({}, {raise_after_freeze: true})
+      }.to raise_error(ArgumentError, 'entered after_freeze with raise option')
+    end
+  end
+end

data/spec/samples/inheritance_sample.rb

@@ -0,0 +1,34 @@
+require 'date'
+require 'renewable'
+
+class PersonA < Renewable::Object
+  attr_accessor :name, :birth_date
+
+  def age
+    Date.today.year - Date.parse(birth_date.to_s).year
+  end
+
+  private
+
+  def process_arguments(attributes, options)
+    if options[:raise_process_arguments]
+      raise ArgumentError, 'entered process_arguments with raise option'
+    end
+
+    return attributes, options
+  end
+
+  def before_freeze(attributes, options)
+    if options[:raise_before_freeze]
+      raise ArgumentError, 'entered before_freeze with raise option'
+    end
+
+    return attributes, options
+  end
+
+  def after_freeze(attributes, options)
+    if options[:raise_after_freeze]
+      raise ArgumentError, 'entered after_freeze with raise option'
+    end
+  end
+end

data/spec/samples/mixin_sample.rb

@@ -0,0 +1,36 @@
+require 'date'
+require 'renewable'
+
+class PersonB
+  include ::Renewable
+
+  attr_accessor :name, :birth_date
+
+  def age
+    Date.today.year - Date.parse(birth_date.to_s).year
+  end
+
+  private
+
+  def process_arguments(attributes, options)
+    if options[:raise_process_arguments]
+      raise ArgumentError, 'entered process_arguments with raise option'
+    end
+
+    return attributes, options
+  end
+
+  def before_freeze(attributes, options)
+    if options[:raise_before_freeze]
+      raise ArgumentError, 'entered before_freeze with raise option'
+    end
+
+    return attributes, options
+  end
+
+  def after_freeze(attributes, options)
+    if options[:raise_after_freeze]
+      raise ArgumentError, 'entered after_freeze with raise option'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+if ENV['CI']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+else
+  require 'simplecov'
+  SimpleCov.start
+end
+
+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.disable_monkey_patching!
+  config.warnings = true
+  config.profile_examples = 5
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: renewable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: Provides frozen by default objects for more Functional style.
+email:
+- james@buypd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/renewable.rb
+- lib/renewable/version.rb
+- renewable.gemspec
+- spec/inhertitance_spec.rb
+- spec/mixin_spec.rb
+- spec/samples/inheritance_sample.rb
+- spec/samples/mixin_sample.rb
+- spec/spec_helper.rb
+homepage: https://github.com/plainprogrammer/renewable
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Provides frozen by default objects
+test_files:
+- spec/inhertitance_spec.rb
+- spec/mixin_spec.rb
+- spec/samples/inheritance_sample.rb
+- spec/samples/mixin_sample.rb
+- spec/spec_helper.rb