has-properties 1.0.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,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rick Button
+
+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,81 @@
+# has-properties
+
+`has_properties` provides an easy way to create basic class definitions with properties. 
+It essentially wraps a lot of `attr_(reader/writer/accessor)` calls into a neat package
+with a nifty initializer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has-properties'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has-properties
+
+## Usage Example
+
+1. Include the `HasProperties` module
+2. Define your properties
+3. ??????
+4. Profit?
+
+```
+    class Example
+      include HasProperties
+    
+      has_read_properties :readable, :another_readable
+      has_write_properties :writable, :another_writable
+      has_properties :readable_and_writable
+    end
+    
+    e = Example.new(:readable => 1, :writable => 2, :readable_and_writable => 3)
+```
+```
+    e.readable
+    => 1
+```
+```
+    e.readable = 2
+    => NoMethodError
+```
+```
+    e.writable
+    => NoMethodError
+```
+```
+    e.writable = 3
+    => 3
+```
+```
+    e.readable_and_writable
+    => 3
+```
+```
+    e.readable_and_writable = 4
+    => 4
+```
+
+### Some notes
+
+You don't have to include every property in the initializer hash. For example, the example above
+defines the `:another_readable` property, but it was never initialized when the object was created.
+This means that a call to `e.another_readable` would equal `nil`.
+
+```
+    e.another_readable
+    => nil
+```
+
+## 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,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/has-properties.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/has-properties/version', __FILE__)
+require File.expand_path('../lib/has_properties', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rick Button"]
+  gem.email         = ["me@rickybutton.com"]
+  gem.description   = %q{Gem that provides an easy way to create basic objects with properties}
+  gem.summary       = %q{Gem that provides an easy way to create basic objects with properties}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "has-properties"
+  gem.require_paths = ["lib"]
+  gem.version       = HasProperties::VERSION
+  
+  %w(rspec rake).each do |g|
+    gem.add_development_dependency g
+  end
+end

data/lib/has-properties/version.rb

@@ -0,0 +1,3 @@
+module HasProperties
+  VERSION = "1.0.0"
+end

data/lib/has_properties.rb

@@ -0,0 +1,43 @@
+module HasProperties
+  attr_accessor :props
+  
+  def has_read_properties(*args)
+    @props ||= []
+    check_unique args
+    @props += args
+    instance_eval { attr_reader *args }
+  end
+  
+  def has_write_properties(*args)
+    @props ||= []
+    check_unique args
+    @props += args
+    instance_eval { attr_writer *args }
+  end
+  
+  def has_read_write_properties(*args)
+    @props ||= []
+    check_unique args
+    @props += args
+    instance_eval { attr_accessor *args }
+  end
+  alias_method :has_properties, :has_read_write_properties
+
+  def self.included base
+    base.extend self
+  end
+
+  def initialize(args)
+    args.each {|k,v|
+      instance_variable_set "@#{k}", v if self.class.props.member?(k)
+    } if args.is_a? Hash
+  end
+  
+  private
+    def check_unique(args)
+      common = @props & args
+      raise(ArgumentError, 
+      "You can only define a property once.\n" +
+      "These properties were defined more than once: #{common.join(',')}") unless common.empty?
+    end
+end

data/spec/has_properties_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe HasProperties do
+  
+  class Test
+    include HasProperties
+    has_read_properties :one, :two
+    has_write_properties :three, :four
+    has_read_write_properties :five
+    has_properties :six
+  end
+  
+  before(:each) do
+    @test = Test.new(:one => 'one', 
+                     :two => 'two', 
+                     :three => 'three', 
+                     :four => 'four', 
+                     :five => 'five',
+                     :six => 'six')
+  end
+  
+  it 'should generate the correct setters' do
+    @test.one.should eq 'one'
+    @test.two.should eq 'two'
+    
+    @test.respond_to?(:three).should be_false
+    @test.respond_to?(:four).should be_false
+    
+    @test.five.should eq 'five'
+    @test.six.should eq 'six'
+  end
+  
+  it 'should generate the correct setters' do
+    @test.respond_to?(:one=).should be_false
+    @test.respond_to?(:two=).should be_false
+    
+    lambda { @test.three = 'new_three' }.should_not raise_error
+    lambda { @test.four = 'new_four' }.should_not raise_error
+    @test.five = 'new_five'
+    @test.six = 'new_six'
+    
+    @test.five.should eq 'new_five'
+    @test.six.should eq 'new_six'
+  end
+  
+  it 'should not throw an error when extra parameters are used' do
+    lambda { Test.new(:random => 'oops poop') }.should_not raise_error
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: has-properties
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Rick Button
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem that provides an easy way to create basic objects with properties
+email:
+- me@rickybutton.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- has-properties.gemspec
+- lib/has-properties/version.rb
+- lib/has_properties.rb
+- spec/has_properties_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: Gem that provides an easy way to create basic objects with properties
+test_files:
+- spec/has_properties_spec.rb
+- spec/spec_helper.rb