classy-adornments 0.1.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.5"
+
+  gem "rspec",   "~> 2.5"
+
+  gem "yard",    "~> 0.6"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Michael Barton
+
+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.rdoc

@@ -0,0 +1,56 @@
+= classy-adornments
+
+More functional versions of the attr, attr\_reader and attr\_writer methods.
+I often find myself repeating these across projects so I've extracted them into
+a gem. Inspired by 'Chapter 2 - Designing Beautiful APIs' in the {'Ruby Best
+Practices' book}[http://rubybestpractices.com/].
+
+== Simple adornment
+
+Provides a single method interface to instance variables. Methods calls without
+an argument return the attribute value. Method calls with an argument set
+corresponding instance variable to this value.
+
+    class Person
+      include ClassyAdornments
+
+      adorn :partner
+    end
+
+    developer = Person.new
+
+    developer.partner                           #=> nil
+    developer.partner "Sophie"
+
+    developer.partner                           #=> "Sophie"
+
+    developer.instance_variable_get("@partner") #=> The instance variable also set
+    developer.partner = "Sophie"                #=> Method variable= also usable
+
+== Array adornment
+
+Provides an adornment using an array as a base. Method calls with an argument
+append the argument to the array. Empty method calls return the array of
+values.
+
+    class Relationship
+      include ClassyAdornments
+
+      adorn :dates, :array => true
+    end
+
+    romance = Relationship.new
+
+    romance.dates                          #=> [] Initialised with empty array
+
+    romance.dates(:wings)                  #=> Value appended to array
+    romance.dates                          #=> [:wings]
+
+    romance.dates([:drive_thru,:tv_night]) #=> Array values also added
+    romance.dates                          #=> [:wings,:drive_thru,:tv_night]
+
+= Copyright
+
+Copyright (c) 2011 Michael Barton. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name        = "classy-adornments"
+  gem.homepage    = "http://github.com/michaelbarton/classy-adornments"
+  gem.license     = "MIT"
+  gem.summary     = %Q{Adorn your classes with fancy attribute methods}
+  gem.description = %Q{Extended class methods for defining attributes.}
+  gem.email       = "mail@michaelbarton.me.uk"
+  gem.authors     = ["Michael Barton"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/classy-adornments.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{classy-adornments}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Barton"]
+  s.date = %q{2011-04-05}
+  s.description = %q{Extended class methods for defining attributes.}
+  s.email = %q{mail@michaelbarton.me.uk}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "classy-adornments.gemspec",
+    "lib/classy_adornments.rb",
+    "spec/classy_adornments_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/michaelbarton/classy-adornments}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Adorn your classes with fancy attribute methods}
+  s.test_files = [
+    "spec/classy_adornments_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5"])
+      s.add_dependency(%q<rspec>, ["~> 2.5"])
+      s.add_dependency(%q<yard>, ["~> 0.6"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5"])
+    s.add_dependency(%q<rspec>, ["~> 2.5"])
+    s.add_dependency(%q<yard>, ["~> 0.6"])
+  end
+end
+

data/lib/classy_adornments.rb

@@ -0,0 +1,41 @@
+module ClassyAdornments
+
+  def self.included(base)
+    base.extend(self)
+  end
+
+  def adorn(name,opts = {})
+    adorn_with name       if opts.empty?
+    adorn_with_array name if opts[:array]
+  end
+
+  private
+
+  def adorn_with(name)
+    define_method(name) do |*args|
+      var = '@' + name.to_s
+      if args.first
+        return instance_variable_set(var,args.first)
+      else
+        return instance_variable_get(var)
+      end
+    end
+    alias_method "#{name}=", name
+  end
+
+  def adorn_with_array(name)
+    define_method(name) do |*args|
+      var = '@' + name.to_s
+      instance_variable_set(var,Array.new) if instance_variable_get(var).nil? 
+      return case args.first
+      when nil
+        instance_variable_get(var)
+      when Array
+        instance_variable_get(var).concat args.first
+      else
+        instance_variable_get(var) << args.first
+      end
+    end
+  end
+
+end

data/spec/classy_adornments_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ClassyAdornments, "#adorn" do
+
+  let(:test_class) do
+    dummy = Class.new
+    dummy.send(:include, ClassyAdornments)
+    dummy
+  end
+
+  describe "with single argument" do
+
+    subject do
+      test_class.adorn :some_attr
+      test_class
+    end
+
+    its(:instance_methods){should include('some_attr') }
+    its(:instance_methods){should include('some_attr=') }
+
+    it "should provide working getter/setter method" do
+      obj = subject.new
+      obj.some_attr.should == nil
+      obj.some_attr(5).should == 5
+      obj.some_attr.should == 5
+    end
+
+    it "should create the an instance variable" do
+      obj = subject.new
+      attribute = Object.new
+      obj.some_attr(attribute)
+
+      obj.instance_variable_get("@some_attr").should equal(attribute)
+    end
+
+  end
+
+  describe "with empty array argument" do
+
+    subject do
+      test_class.adorn :array_attr, :array => true
+      test_class.new
+    end
+
+    its("class.instance_methods"){should     include('array_attr') }
+    its("class.instance_methods"){should_not include('array_attr=') }
+
+    it "should append single values" do
+      subject.array_attr.should == []
+      subject.array_attr :something
+      subject.array_attr.should == [:something]
+    end
+
+    it "should append an array of values" do
+      subject.array_attr.should == []
+      subject.array_attr 1
+      subject.array_attr [2,3]
+      subject.array_attr.should == [1,2,3]
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'classy_adornments'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: classy-adornments
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Michael Barton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :development
+  name: yard
+  prerelease: false
+  version_requirements: *id004
+description: Extended class methods for defining attributes.
+email: mail@michaelbarton.me.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- classy-adornments.gemspec
+- lib/classy_adornments.rb
+- spec/classy_adornments_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/michaelbarton/classy-adornments
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adorn your classes with fancy attribute methods
+test_files: 
+- spec/classy_adornments_spec.rb
+- spec/spec_helper.rb