accessor 1.0.2

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/.travis.yml

@@ -0,0 +1,2 @@
+- 1.9.2
+- 1.9.3

data/CHANGELOG.mdown

@@ -0,0 +1,50 @@
+
+1.0.2 / 2012-01-17 
+==================
+
+  * Fixing the listed version
+  * Detailing the gemspec
+  * Updating the readme with real details
+  * Merge branch 'release/1.0.0' into develop
+
+1.0.0 / 2012-01-16 
+==================
+
+  * Delgating to attribute for writer and accessor
+  * Delegating for writer and accessor
+  * Raising on no names given, for accessor and writer
+  * Returning self for chaining
+  * Delegating to the class method
+  * Raising if no names given
+  * Going over each name given and creating an attribute
+  * Defining the method for the property and proc
+  * Raising if it doesnt match reader, writer, or accessor
+  * Returning the ivar value if no arg given
+  * Determining how to treat arg given
+  * Writing accessor proc generator
+  * Writing writer proc generator
+  * Writing logic on proc generation
+  * Checking if types are correct
+  * Dropping scaffold comment
+  * Extending the Object class with Accessor
+  * Defining the core attributes method and documentation
+  * Defining the instance accessor method and documentation
+  * Defining the accessor metamethod and documentation
+  * Defining the instance writer method and docs
+  * Defining the writer metamethod and docs
+  * Defining the instance reader method and docs
+  * Defining the reader metamethod and documentation
+  * Adding documentation on the possible API
+  * Creating a test for features in Accessor
+  * Comparing attr to Accessor via benchmark
+  * Adding a simple example of the API
+  * Adding in a Guardfile for continous testing
+  * Adding a dummy class for my tests
+  * Adding pride to my tests
+  * Fixing rocco problem with redcarpet version
+  * Adding the initial changelog
+
+0.0.1 / 2012-01-16 
+==================
+
+  * Initial bundler scaffold

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,26 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  watch(/^.+\.gemspec/)
+end
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/test_(.*)\.rb|)
+  watch(%r|^lib/(.*)\.rb|)            { |m| "test/test_#{m[1]}.rb" }
+  watch(%r|^test/helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end
+
+guard 'rocco' do
+  watch(%r{^lib/.*\.rb$})
+end
+
+watch(%r|^benchmarks/(.*)\.rb$|)     { |m| eval File.read "benchmarks/#{m[1]}.rb" }

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kurtis Rainbolt-Greene
+
+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,136 @@
+accessor
+========
+
+The accessor gem is for giving you easy syntax sugar for getters, setters, and accessors.
+
+
+usage
+-----
+
+Sure, you can use `attr_accessor`, `attr_reader`, and `attr_writer` but the `attr` gang can't do this!:
+
+  - Chain together setters: `person.name("Kurtis").email("me+accessor@kurtisrainboltgreene.name").age(24)`
+  - Define new accessors, getters, and setters on instances: `person.accessor!(:secret_token)`
+  - Do both: `person.accessor(:api_token, :dashboard_token).api_token(generated_token).dashboard_token`
+
+Here's an example:
+
+``` ruby
+require 'accessor'
+
+class Person
+  accessor :name, :email
+  writer :password
+  reader :encrypted_password
+
+  def encrypt_password!
+    @encrypted_password = Base64::strict_encode64(@password)
+  end
+
+end
+
+contact = Person.new
+contact.name "Kurtis Rainbolt-Greene"
+contact.email "me+accessor@kurtisrainboltgreene.name"
+contact.email
+
+contact.accessor!(:age).age 24
+```
+
+
+installing
+----------
+
+**Requirements**
+
+1. Ruby MRI 1.9+
+2. RubyGems 1.6+
+
+Like any other gem, all you have to do is either use:
+
+``` bash
+$ gem install accessor
+```
+
+Or add it to your `Gemfile`:
+
+``` ruby
+source :rubygems
+
+gem "accessor", "1.0.2"
+```
+
+That's all you have to do.
+
+**Testing**
+
+To make sure you did everything right do the following:
+
+``` ruby
+ruby -e "p require 'accessor'"
+true
+```
+
+
+issues & documentation
+----------------------
+
+* [Documentation](http://krainboltgreene.github.com/accessor/documentation)
+* [Issues](https://github.com/krainboltgreene/accessor/issues)
+
+We welcome any pull requests or commits that improve `accessor`.
+
+
+changelog
+---------
+
+  - 1.0.2: Adding helpful README and gemspec details
+  - 1.0.0: Initial release
+
+
+contributing
+------------
+
+* **Fork** the repository
+* **Clone the repository** locally, or **edit via Github**
+* Create a **new branch** using the [Git Flow Standard](http://yakiloo.com/getting-started-git-flow/) conventions
+* Commit **often** and **when important**
+* **DO NOT CHANGE** ANY OF THESE (without making a new branch for *that* change):
+  * `*.gemspec`
+  * `Rakefile`
+  * `.rvmrc`
+  * `.gitignore`
+  * Any part of the git history
+* **Write tests** specifically for the changes you've made, if no test exist
+* **Push** your feature or hotfix branch to Github.
+* Make a **Pull Request**
+
+
+Credits
+-------
+
+  - Myself!...So far.
+
+License
+-------
+
+Copyright (c) 2012 Kurtis Rainbolt-Greene
+
+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/Rakefile

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

data/accessor.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/accessor/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kurtis Rainbolt-Greene"]
+  gem.email         = ["kurtisrainboltgreene@gmail.com"]
+  gem.description   = "A syntactically better accessor, setter, and getter metamethod generator"
+  gem.summary       = %q{A syntactically better accessor, setter, and getter metamethod generator}
+  gem.homepage      = "http://krainboltgreene.github.com/accessor"
+
+  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          = "accessor"
+  gem.require_paths = ["lib"]
+  gem.version       = Accessor::VERSION
+
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rocco', '~> 0.8'
+  gem.add_development_dependency 'redcarpet', '~> 1.7'
+  gem.add_development_dependency 'awesome_print', '~> 1.0'
+  gem.add_development_dependency 'guard', '~> 0.10'
+  gem.add_development_dependency 'guard-minitest', '~> 0.4'
+  gem.add_development_dependency 'guard-rocco', '~> 0.0.3'
+  gem.add_development_dependency 'guard-bundler', '~> 0.1'
+end

data/benchmarks/vs_attr.rb

@@ -0,0 +1,42 @@
+require 'benchmark'
+
+accessor_time = Benchmark.realtime do
+  require 'accessor'
+  class Person
+    accessor :name, :email
+    writer :password
+    reader :encrypted_password
+
+    def encrypt_password!
+      @encrypted_password = Base64::strict_encode64(@password)
+    end
+
+  end
+
+  contact = Person.new
+  contact.name "Kurtis Rainbolt-Greene"
+  contact.email "me+accessor@kurtisrainboltgreene.name"
+  contact.email
+end
+
+attr_time = Benchmark.realtime do
+  class Person
+    attr_accessor :name, :email
+    attr_reader :password
+    attr_writer :encrypted_password
+
+    def encrypt_password!
+      @encrypted_password = Base64::strict_encode64(@password)
+    end
+
+  end
+
+  contact = Person.new
+  contact.name = "Kurtis Rainbolt-Greene"
+  contact.email = "me+accessor@kurtisrainboltgreene.name"
+  contact.email
+end
+
+puts "Benchmarks Accessor vs attr:"
+puts "  - Accessor: Time elapsed #{accessor_time * 1000}ms"
+puts "  - attr: Time elapsed #{attr_time * 1000}ms"

data/example/example_1.rb

@@ -0,0 +1,20 @@
+require 'accessor'
+
+class Person
+  accessor :name, :email
+  writer :password
+  reader :encrypted_password
+
+  def encrypt_password!
+    @encrypted_password = Base64::strict_encode64(@password)
+  end
+
+end
+
+contact = Person.new
+contact.name "Kurtis Rainbolt-Greene"
+contact.email "me+accessor@kurtisrainboltgreene.name"
+contact.email
+
+contact.accessor!(:age).age 24
+p contact

data/lib/accessor.rb

@@ -0,0 +1,131 @@
+require "accessor/version"
+
+# The Accessor library is for giving your setters, getters, and accessors 
+# a more suggary syntax:
+#
+# 
+#     class Person
+#       accessor :name, :email
+#       writer :password
+#       reader :encrypted_password
+# 
+#       def encrypt_password!
+#         @encrypted_password = Base64::strict_encode64(@password)
+#       end
+#
+#     end
+#
+#     contact = Person.new
+#     contact.name "Kurtis Rainbolt-Greene"
+#     contact.email "me+accessor@kurtisrainboltgreene.name"
+#     contact.email
+#       # => "me+accessor@kurtisrainboltgreene.name"
+#     contact.password "ilovehorsesthateatglue"
+#     contact.password
+#       # => 0 for 1 arguments
+#     contact.encrypted_password "Test!"
+#       # => 1 for 0 arguments
+#     contact.encrypt_password!
+#     contact.encrypted_password
+#       # => "MTIzNDEyMzQ="
+#     contact.name("James Earl Jones").email("jejones@gmail.com")
+#       # => #<Person:0x3E034 @name="James Earl Jones" @email="jejones@gmail.com">
+#
+module Accessor
+  # The `reader` method is a metamethod, and it takes an `Array` of `Symbols`.
+  # It goes over each `Symbol` and calls the `attribute` method with the 
+  # `Symbol` as an argument, creating a getter method.
+  def reader(*names)
+    names.each { |name| attribute name, :reader }
+  end
+
+  # The `reader!` method is a metamethod, and it takes the same arguments as `reader`.
+  # The difference between the two are that `reader!` is used to define getter methods
+  # for the class of an instance object.
+  def reader!(*names)
+    raise ArgumentError unless names.any?
+    self.class.reader(*names)
+    self
+  end
+
+
+  # The `writer` method is a metamethod, and it takes an `Array` of `Symbols`.
+  # It goes over each `Symbol` and calls the `attribute` method with the 
+  # `Symbol` as an argument, creating a setter method.
+  def writer(*names)
+    names.each { |name| attribute name, :writer }
+  end
+
+  # The `writer!` method is a metamethod, and it takes the same arguments as `writer`.
+  # The difference between the two are that `writer!` is used to define setter methods
+  # for the class of an instance object.
+  def writer!(*names)
+    raise ArgumentError unless names.any?
+    self.class.writer(*names)
+    self
+  end
+
+
+  # The `accessor` method is a metamethod, and it takes an `Array` of `Symbols`.
+  # It goes over each `Symbol` and calls the `attribute` method with the 
+  # `Symbol` as an argument, creating both a getter and setter method.
+  def accessor(*names)
+    names.each { |name| attribute name }
+  end
+
+  # The `accessor!` method is a metamethod, and it takes the same arguments as `accessor`.
+  # The difference between the two are that `accessor!` is used to define setter/getter methods
+  # for the class of an instance object.
+  def accessor!(*names)
+    raise ArgumentError unless names.any?
+    self.class.accessor(*names)
+    self
+  end
+
+  private
+    # The `attribute` method is the metamethod behind `accessor`, `writer`, and `reader`.
+    # It takes two `Symbols`, but has a default for the last.
+    def attribute(name, type = :accessor)
+      # If the `name` or `type` parameters are anything but `Symbol` classes
+      # then it should raise a TypeError.
+      raise TypeError unless name.is_a?(Symbol) && type.is_a?(Symbol)
+
+      # Based on the `Symbol` passed in as `type` determine what kind of `Proc` to create.
+      block = case type
+
+        # For getter metamethods, pass along a block that accesses the instance variable
+        when :reader then -> { instance_variable_get "@#{name}".to_sym }
+
+        # For setter metamethods, pass along a block that takes a single argument and 
+        # sets the instance variable to that value, finally returning `self`. The `self` 
+        # return allows for cool chaining like `person.age(24).name("Katie")`
+        when :writer then ->(arg) { instance_variable_set "@#{name}".to_sym, arg; self }
+
+        # Finally for both functionalities the accessor metamethod does both the setter and
+        # reader based on if an argument was passed or not (default not).
+        when :accessor
+          ->(arg = nil) {
+            if arg
+              instance_variable_set "@#{name}".to_sym, arg
+              self
+            else
+              instance_variable_get "@#{name}".to_sym
+            end
+          }
+        # If for some reason the `type` parameter was a Symbol, but not those listed above
+        # then raise an `ArgumentError`
+        else raise ArgumentError
+      end
+
+      # Finally define an instance method on the class with the `name` parameter and
+      # `Proc` created.
+      define_method name, block
+    end
+end
+
+# Extend the main object with the `Accessor` module to populate it with the correct
+# method singleton methods.
+class Object
+  extend Accessor
+  include Accessor
+end

data/lib/accessor/version.rb

@@ -0,0 +1,3 @@
+module Accessor
+  VERSION = "1.0.2"
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require "minitest/pride"
+require 'minitest/autorun'
+require 'accessor'
+
+class Person
+  accessor :name, :email
+  writer :password
+  reader :encrypted_password
+
+  def encrypt_password!
+    @encrypted_password = Base64::strict_encode64(@password)
+  end
+
+end

data/test/test_accessor.rb

@@ -0,0 +1,89 @@
+require 'minitest/autorun'
+require_relative 'helper'
+
+class TestAccessor < MiniTest::Unit::TestCase
+
+  def setup
+    @iperson = Person.new
+  end
+
+  def test_person_class_has_accessor_method
+    assert_respond_to Person, :accessor
+  end
+
+  def test_person_class_has_writer_method
+    assert_respond_to Person, :writer
+  end
+
+  def test_person_class_has_reader_method
+    assert_respond_to Person, :reader
+  end
+
+  def test_person_has_name_accessor
+    assert_respond_to @iperson, :name
+  end
+
+  def test_person_has_email_accessor
+    assert_respond_to @iperson, :email
+  end
+
+  def test_person_has_password_writer
+    assert_respond_to @iperson, :password
+  end
+
+  def test_person_has_encrypted_password_reader
+    assert_respond_to @iperson, :encrypted_password
+  end
+
+  def test_cant_read_password_ivariable
+    assert_raises(ArgumentError) { @iperson.password }
+  end
+
+  def test_cant_write_encrypted_password_ivariable
+    assert_raises(ArgumentError) { @iperson.encrypted_password("test") }
+  end
+
+  def test_person_has_accessor_method
+    assert_respond_to @iperson, :accessor!
+  end
+
+  def test_person_has_writer_method
+    assert_respond_to @iperson, :writer!
+  end
+
+  def test_person_has_reader_method
+    assert_respond_to @iperson, :reader!
+  end
+
+  def test_iaccessor_defines_getter_method
+    @iperson.accessor! :age
+    assert_respond_to @iperson, :age
+  end
+
+  def test_iaccessor_defines_setter_method
+    @iperson.accessor! :age
+    assert_send [@iperson, :age, 23]
+  end
+
+  def test_ireader_defines_getter_method
+    @iperson.reader! :age
+    assert_respond_to @iperson, :age
+  end
+
+  def test_iwritter_defines_setter_method
+    @iperson.writer! :age
+    assert_send [@iperson, :age, 23]
+  end
+
+  def test_iaccessor_requires_names
+    assert_raises(ArgumentError) { @iperson.accessor! }
+  end
+
+  def test_ireader_requires_names
+    assert_raises(ArgumentError) { @iperson.reader! }
+  end
+
+  def test_iwriter_requires_names
+    assert_raises(ArgumentError) { @iperson.writer! }
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: accessor
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156430340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *2156430340
+- !ruby/object:Gem::Dependency
+  name: rocco
+  requirement: &2156429780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: *2156429780
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &2156429280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2156429280
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &2156428780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156428780
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2156428260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: *2156428260
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: &2156427760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: *2156427760
+- !ruby/object:Gem::Dependency
+  name: guard-rocco
+  requirement: &2156427120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: *2156427120
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &2156426540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: *2156426540
+description: A syntactically better accessor, setter, and getter metamethod generator
+email:
+- kurtisrainboltgreene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.mdown
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- accessor.gemspec
+- benchmarks/vs_attr.rb
+- example/example_1.rb
+- lib/accessor.rb
+- lib/accessor/version.rb
+- test/helper.rb
+- test/test_accessor.rb
+homepage: http://krainboltgreene.github.com/accessor
+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.10
+signing_key: 
+specification_version: 3
+summary: A syntactically better accessor, setter, and getter metamethod generator
+test_files:
+- test/helper.rb
+- test/test_accessor.rb