attr_defaultable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bd280ebe82da7f21b9542ce3da7ff26b71063f4
-  data.tar.gz: d54b8c9fdcea1fb30e707c92d0b2b630316305b9
+  metadata.gz: ff37f551cddbe51c450c7d5097a2c243d10e01de
+  data.tar.gz: cfba85ed78f6acbda0c144883b8f698bbf129d28
 SHA512:
-  metadata.gz: 3de3817b42411f25c54f81a46a2d6c7fdc2c9e08cf11f8002a2f4d2d04b3f185a09a3ab772fac22f21d415fa9a62c3cb4d479f8f89fbd2fac39a3f9319c74423
-  data.tar.gz: 18649e27262055059a791c083b448ac5eb80ad79d05e153ce9b3df947604a4d63159c49770c93d736eede9f36f34607489e2f1467d0e31cfd1020f5de3fd2b5a
+  metadata.gz: be4f222217699198cef48a510c2630f0042392e3f31d3277a27b1ef2e0d8ec8c6c5dad41872b10d245c9f2f405be3e7f8cf8b8900343a0980203778cd29a6e50
+  data.tar.gz: 8ebff3673df74a1e633eacc8db5b9ea03985fa29dfb30a1f815542f7df762ac7918079d8b2e97ac2e427b5765505a20d4a98ff73da1624db21692a6e008e6ecc

data/README.md

@@ -1,6 +1,6 @@
 # AttrDefaultable
 
-TODO: Write a gem description
+Easily add attributes with default values to your classes.
 
 ## Installation
 
@@ -8,6 +8,10 @@ Add this line to your application's Gemfile:
 
     gem 'attr_defaultable'
 
+To optionally slip attr_defaultable into Module so it is available without extending:
+
+    gem 'attr_defaultable', require: 'extend_attr_defaultable'
+
 And then execute:
 
     $ bundle
@@ -18,11 +22,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class Example
+  extend AttrDefaultable
+  attr_defaultable :foo, -> { 'bar' }
+end
+```
+
+This will create a getter/setter pair for your variable `foo`. If the setter is not used before the getter
+the proc given will be called and it's result used to set the value of `foo`.
+
+Very useful for creating dependency definitions with protected default values that are evaluated just in time.
+
+## Alternate Usage
+
+By using the alternate gem declaration in your Gemfile or manually
+requiring `extend_attr_defaultable` early in your application, you can avoid the explicit `extend`
+in your class.
+
+```ruby
+class Example
+  attr_defaultable :foo, -> { 'bar' }
+end
+```
+
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/attr_defaultable/fork )
+1. Fork it ( http://github.com/Originate/attr_defaultable/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`)

data/Rakefile

@@ -4,3 +4,19 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+task :extended_console do
+  require 'irb'
+  require 'irb/completion'
+  require 'extend_attr_defaultable'
+  ARGV.clear
+  IRB.start
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'attr_defaultable'
+  ARGV.clear
+  IRB.start
+end

data/lib/attr_defaultable/version.rb

@@ -1,3 +1,3 @@
 module AttrDefaultable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/extend_attr_defaultable.rb

@@ -0,0 +1,4 @@
+require "attr_defaultable"
+class Module
+  include AttrDefaultable
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_defaultable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - alexpeachey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,7 @@ files:
 - attr_defaultable.gemspec
 - lib/attr_defaultable.rb
 - lib/attr_defaultable/version.rb
+- lib/extend_attr_defaultable.rb
 - spec/attr_defaultable_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Originate/attr_defaultable
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An additional attr macro for default values.