defaultinator 0.5.0

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 @@
+--colour

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 EmberAds Ltd <hello@emberads.com>
+
+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,58 @@
+# Defaultinator
+
+Allows you to set default values when setting attributes using `attr_accessor` or `attr_reader`. Saves having to define attributes then instantly override them to set a default method.
+
+Turns this:
+
+    class Foo
+      attr_accessor :things
+      def things
+        @things ||= []
+      end
+    end
+
+into this:
+
+    class Foo
+      attr_accessor :things, default: []
+    end
+
+Also works with `attr_accessor` or `attr_reader` in modules, and with passing multiple attributes to define at once.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'defaultinator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install defaultinator
+
+## Usage
+
+If you're not setting default values for the attribute, then just use `attr_accessor` (or `attr_reader`) as normal including setting multiple attributes at once.
+
+    attr_accessor :foo
+    attr_accessor :sed, :fred
+    attr_reader :bar
+    attr_reader :george, :paul
+
+If you want default values, it's much the same but just pass a hash as the last argument stating what the default value is.
+
+    attr_accessor :foo, default: true
+    attr_accessor :sed, :fred, default: []
+    attr_reader :bar, default: {}
+    attr_reader :george, :paul, default: false
+
+## 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/defaultinator.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/defaultinator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Caius Durling"]
+  gem.email         = ["caius@emberads.com"]
+  gem.description   = %q{Allows you to set default values when setting attributes using attr_accessor or attr_reader.}
+  gem.summary       = %q{Set default values on attributes in one line}
+  gem.homepage      = "http://github.com/caius/defaultinator"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "defaultinator"
+  gem.require_paths = ["lib"]
+  gem.version       = Defaultinator::VERSION
+
+  gem.add_development_dependency "rspec", "> 2.0.0"
+end

data/lib/defaultinator.rb

@@ -0,0 +1,31 @@
+require "defaultinator/version"
+
+class Module
+  # todo: figure out how to mix this in as a module slightly nicer
+  alias_method :__original_attr_accessor, :attr_accessor
+  def attr_accessor *args
+    return send(:__original_attr_accessor, *args) unless args.last.is_a?(Hash)
+    *method_names, method_options = args
+    attr_reader(*method_names, method_options)
+    attr_writer(*method_names)
+  end
+
+  alias_method :__original_attr_reader, :attr_reader
+  def attr_reader *args
+    # Hand-off if no options for us to be clever with
+    return send(:__original_attr_reader, *args) unless args.last.is_a?(Hash)
+
+    *method_names, method_options = args
+
+    # Hand-off if no defaults or if the default is nil, because that's the ruby runtime default too.
+    return send(:__original_attr_reader, *method_names) unless method_options.has_key?(:default) && method_options[:default] != nil
+
+    method_names.uniq.each do |name|
+      instance_name = "@#{name}".to_sym
+      # @foo ||= {}
+      define_method(name) do
+        instance_variable_defined?(instance_name) && instance_variable_get(instance_name) || instance_variable_set(instance_name, method_options[:default])
+      end
+    end
+  end
+end

data/lib/defaultinator/version.rb

@@ -0,0 +1,3 @@
+module Defaultinator
+  VERSION = "0.5.0"
+end

data/spec/defaultinator_spec.rb

@@ -0,0 +1,139 @@
+require "defaultinator"
+
+describe Defaultinator, "attributes defined in a class with no default" do
+  before do
+    @instance = Class.new do
+      attr_accessor :attribute_1
+      attr_accessor :attribute_2, :attribute_3
+      attr_reader :attribute_4
+      attr_reader :attribute_5, :attribute_6
+    end.new
+  end
+  describe "attr_accessor" do
+    it "should define the getters returning nil" do
+      @instance.attribute_1.should be_nil
+      @instance.attribute_2.should be_nil
+      @instance.attribute_3.should be_nil
+    end
+    it "should define the setters" do
+      @instance.attribute_1 = :foo
+      @instance.attribute_1.should be == :foo
+      @instance.attribute_2 = :foo
+      @instance.attribute_2.should be == :foo
+      @instance.attribute_3 = :foo
+      @instance.attribute_3.should be == :foo
+    end
+  end
+  describe "#attr_reader" do
+    it "should define the getters returning nil" do
+      @instance.attribute_4.should be_nil
+      @instance.attribute_5.should be_nil
+      @instance.attribute_6.should be_nil
+    end
+  end
+end
+
+describe Defaultinator, "attributes defined in a class with default" do
+  before do
+    @instance = Class.new do
+      attr_accessor :attribute_1, default: []
+      attr_accessor :attribute_2, :attribute_3, default: []
+      attr_reader :attribute_4, default: false
+      attr_reader :attribute_5, :attribute_6, default: false
+    end.new
+  end
+  describe "#attr_accessor" do
+    it "should define the getters returning default value" do
+      @instance.attribute_1.should be == []
+      @instance.attribute_2.should be == []
+      @instance.attribute_3.should be == []
+    end
+    it "should define the setters" do
+      @instance.attribute_1 = :foo
+      @instance.attribute_1.should be == :foo
+      @instance.attribute_2 = :foo
+      @instance.attribute_2.should be == :foo
+      @instance.attribute_3 = :foo
+      @instance.attribute_3.should be == :foo
+    end
+  end
+  describe "#attr_reader" do
+    it "should define the getters returning default value" do
+      @instance.attribute_4.should be_false
+      @instance.attribute_5.should be_false
+      @instance.attribute_6.should be_false
+    end
+  end
+end
+
+describe Defaultinator, "attributes defined in a module with no default" do
+  before do
+    mod = Module.new do
+      attr_accessor :attribute_1
+      attr_accessor :attribute_2, :attribute_3
+      attr_reader :attribute_4
+      attr_reader :attribute_5, :attribute_6
+    end
+    @instance = Class.new do
+      include mod
+    end.new
+  end
+  describe "attr_accessor" do
+    it "should define the getters returning nil" do
+      @instance.attribute_1.should be_nil
+      @instance.attribute_2.should be_nil
+      @instance.attribute_3.should be_nil
+    end
+    it "should define the setters" do
+      @instance.attribute_1 = :foo
+      @instance.attribute_1.should be == :foo
+      @instance.attribute_2 = :foo
+      @instance.attribute_2.should be == :foo
+      @instance.attribute_3 = :foo
+      @instance.attribute_3.should be == :foo
+    end
+  end
+  describe "#attr_reader" do
+    it "should define the getters returning nil" do
+      @instance.attribute_4.should be_nil
+      @instance.attribute_5.should be_nil
+      @instance.attribute_6.should be_nil
+    end
+  end
+end
+
+describe Defaultinator, "attributes defined in a module with default" do
+  before do
+    mod = Module.new do
+      attr_accessor :attribute_1, default: []
+      attr_accessor :attribute_2, :attribute_3, default: []
+      attr_reader :attribute_4, default: false
+      attr_reader :attribute_5, :attribute_6, default: false
+    end
+    @instance = Class.new do
+      include mod
+    end.new
+  end
+  describe "#attr_accessor" do
+    it "should define the getters returning default value" do
+      @instance.attribute_1.should be == []
+      @instance.attribute_2.should be == []
+      @instance.attribute_3.should be == []
+    end
+    it "should define the setters" do
+      @instance.attribute_1 = :foo
+      @instance.attribute_1.should be == :foo
+      @instance.attribute_2 = :foo
+      @instance.attribute_2.should be == :foo
+      @instance.attribute_3 = :foo
+      @instance.attribute_3.should be == :foo
+    end
+  end
+  describe "#attr_reader" do
+    it "should define the getters returning default value" do
+      @instance.attribute_4.should be_false
+      @instance.attribute_5.should be_false
+      @instance.attribute_6.should be_false
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: defaultinator
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Caius Durling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70255695206920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70255695206920
+description: Allows you to set default values when setting attributes using attr_accessor
+  or attr_reader.
+email:
+- caius@emberads.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- defaultinator.gemspec
+- lib/defaultinator.rb
+- lib/defaultinator/version.rb
+- spec/defaultinator_spec.rb
+homepage: http://github.com/caius/defaultinator
+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.15
+signing_key: 
+specification_version: 3
+summary: Set default values on attributes in one line
+test_files:
+- spec/defaultinator_spec.rb