better_attrs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af8eff6df461e23c181ad4fdb54890deff900c7a
+  data.tar.gz: 48470107f367a89ead3367311bd54e55f8517cf2
+SHA512:
+  metadata.gz: cb5c88f788985d41c6263be30b3990357f7da2a5235bfafa78afda881ab6bd3d3a4e6184f1ad86e156740fb02913422205d6e23dc44e6043effe764d8315901e
+  data.tar.gz: df297bbf889bcc83fde1247e3e8f555aec95a4f0d053c281e540eb9acc7b55c40ab8c68351338c4ef9d0a3334e28b1b1ec1d85aec320cb9cb8758f172b19baac

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-gemset
+.ruby-version
+coverage
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tags
+tags.*
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+  - 2.2.0
+  - jruby-19mode
+  - rbx-2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonathan W. Zaleski
+
+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,59 @@
+# BetterAttrs
+
+[![Build Status](https://secure.travis-ci.org/jzaleski/better_attrs.png?branch=master)](http://travis-ci.org/jzaleski/better_attrs)
+
+Enhances `attr_accessor` and `attr_writer` to allow the specification of a callback to be invoked when an attribute value is changed.
+
+Ideal for cascading updates or deployment scenarios where it is necessary to keep legacy values in sync until a time that they can be safely removed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'better_attrs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install better_attrs
+
+## Usage
+
+The callback key is the attribute name, suffixed by either `_changed` or `_updated` (both behave identically).
+
+In the examples below the callback (specified as `:foo_changed`) will be invoked when the value of `foo` changes.
+
+A callback can be:
+
+* a `lambda`
+* a `proc`
+* a `String` or `Symbol` (referring to a method)
+
+In all cases the callback *must* be callable and *must* accept two arguments (the `old_value` and the `new_value` of the related attribute).
+
+Adding a callback to an `attr_accessor` in new or existing class:
+
+```ruby
+class AnyClass
+  attr_accessor :foo, :foo_changed => proc { |old_value, new_value| }
+end
+```
+
+Adding a callback to an `attr_writer` in a new or existing class:
+
+```ruby
+class AnyClass
+  attr_writer :foo, :foo_changed => proc { |old_value, new_value| }
+end
+```
+
+## Contributing
+
+1. Fork it (http://github.com/jzaleski/better_attrs/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = %w[--format progress]
+end
+
+task :test => :spec
+
+task :default => :test

data/better_attrs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'better_attrs/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'better_attrs'
+  gem.version = BetterAttrs::VERSION
+  gem.authors = ['Jonathan W. Zaleski']
+  gem.email = ['JonathanZaleski@gmail.com']
+  gem.summary = 'Enhances `attr_accessor` and `attr_writer` to allow the specification of a callback to be invoked when an attribute value is changed.'
+  gem.description = "#{gem.summary} Ideal for cascading updates or deployment scenarios where it is necessary to keep legacy values in sync until a time that they can be safely removed."
+  gem.homepage = 'https://github.com/jzaleski/better_attrs'
+  gem.license = 'MIT'
+
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}) { |file| File.basename(file) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'pry', '~> 0.10'
+  gem.add_development_dependency 'rake', '~> 10.4'
+  gem.add_development_dependency 'rspec', '~> 3.1'
+end

data/lib/better_attrs.rb

@@ -0,0 +1,2 @@
+require 'better_attrs/class'
+require 'better_attrs/version'

data/lib/better_attrs/class.rb

@@ -0,0 +1,70 @@
+class Class
+  private
+
+  alias_method :original_attr_accessor, :attr_accessor
+
+  def attr_accessor(*args)
+    attr_reader *extract_attrs_from_args(args)
+    attr_writer *args
+  end
+
+  alias_method :original_attr_writer, :attr_writer
+
+  def attr_writer(*args)
+    attrs = extract_attrs_from_args(args)
+    opts = extract_opts_from_args(args)
+    attrs.each { |attr| define_attr_writer(attr, opts) }
+  end
+
+  def callback_for_attr(attr, opts)
+    opts[:"#{attr}_changed"] || opts[:"#{attr}_updated"]
+  end
+
+  def define_attr_writer(attr, opts)
+    class_eval do
+      # Memoized state
+      instance_variable = instance_variable_for_attr(attr)
+      callback = callback_for_attr(attr, opts)
+      writer_method = writer_method_for_attr(attr)
+
+      define_method(writer_method) do |new_value|
+        # Capture the `old_value`
+        old_value = instance_variable_get(instance_variable)
+
+        # Short-circuit if the values are the same
+        return new_value if old_value == new_value
+
+        # Update the instance-variable
+        instance_variable_set(instance_variable, new_value)
+
+        # Update the attributes `Hash` if it is present
+        send(:[]=, attr, new_value) if defined?(::Rails) && respond_to?(:attributes)
+
+        # Short-circuit if no callback was specified
+        return new_value if callback.nil?
+
+        # Callable object (e.g. `Proc`, `Lambda`)
+        instance_exec(old_value, new_value, &callback) if callback.respond_to?(:call)
+
+        # Method name (must be `String` or `Symbol`)
+        send(callback, old_value, new_value) if [String, Symbol].include?(callback.class)
+      end
+    end
+  end
+
+  def extract_attrs_from_args(args)
+    args.last.is_a?(Hash) ? args[0..-2] : args
+  end
+
+  def extract_opts_from_args(args)
+    args.last.is_a?(Hash) ? args.last : {}
+  end
+
+  def instance_variable_for_attr(attr)
+    :"@#{attr}"
+  end
+
+  def writer_method_for_attr(attr)
+    :"#{attr}="
+  end
+end

data/lib/better_attrs/version.rb

@@ -0,0 +1,3 @@
+module BetterAttrs
+  VERSION = '0.0.1'
+end

data/spec/attr_accessor_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+class AttrAccessor; end
+
+describe AttrAccessor do
+  let(:klass) { subject.class }
+
+  it 'will accept a `lambda` as a valid callback' do
+    expect do
+      klass.class_eval do
+        attr_accessor :foo, :foo_changed => lambda { |old_value, new_value| }
+      end
+    end.to_not raise_error
+
+    expect(subject).to respond_to(:foo=)
+    expect(subject).to respond_to(:foo)
+  end
+
+  it 'will accept a `proc` as a valid callback' do
+    expect do
+      klass.class_eval do
+        attr_accessor :foo, :foo_changed => proc { |old_value, new_value| }
+      end
+    end.to_not raise_error
+
+    expect(subject).to respond_to(:foo=)
+    expect(subject).to respond_to(:foo)
+  end
+
+  it 'will accept a `String` as a valid callback' do
+    expect do
+      klass.class_eval do
+        attr_accessor :foo, :foo_changed => 'foo_changed'
+      end
+    end.to_not raise_error
+
+    expect(subject).to respond_to(:foo=)
+    expect(subject).to respond_to(:foo)
+  end
+
+  it 'will accept a `Symbol` as a valid callback' do
+    expect do
+      klass.class_eval do
+        attr_accessor :foo, :foo_changed => :foo_changed
+      end
+    end.to_not raise_error
+
+    expect(subject).to respond_to(:foo=)
+    expect(subject).to respond_to(:foo)
+  end
+end

data/spec/attr_writer_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+class AttrWriter; end
+
+describe AttrWriter do
+  let(:klass) { subject.class }
+
+  it 'will accept a `lambda` as a valid callback' do
+    expect do
+      klass.class_eval do
+        attr_writer :foo, :foo_changed => lambda { |old_value, new_value| }
+      end
+    end.to_not raise_error
+
+    expect(subject).to respond_to(:foo=)
+    expect(subject).not_to respond_to(:foo)
+  end
+
+  it 'will accept a `proc` as a valid callback' do
+    expect do
+      klass.class_eval do
+        attr_writer :foo, :foo_changed => proc { |old_value, new_value| }
+      end
+    end.to_not raise_error
+
+    expect(subject).to respond_to(:foo=)
+    expect(subject).not_to respond_to(:foo)
+  end
+
+  it 'will accept a `String` as a valid callback' do
+    expect do
+      klass.class_eval do
+        attr_writer :foo, :foo_changed => 'foo_changed'
+      end
+    end.to_not raise_error
+
+    expect(subject).to respond_to(:foo=)
+    expect(subject).not_to respond_to(:foo)
+  end
+
+  it 'will accept a `Symbol` as a valid callback' do
+    expect do
+      klass.class_eval do
+        attr_writer :foo, :foo_changed => :foo_changed
+      end
+    end.to_not raise_error
+
+    expect(subject).to respond_to(:foo=)
+    expect(subject).not_to respond_to(:foo)
+  end
+end

data/spec/simple_attr_accessor_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+class SimpleAttrAccessor
+  attr_accessor :foo, :bar, :foo_changed => :foo_changed
+
+  def foo_changed(old_value, new_value); end
+end
+
+describe SimpleAttrAccessor do
+  it 'will call `foo_changed` when `foo` is updated' do
+    expect(subject).to receive(:foo_changed).with(nil, 2)
+
+    subject.foo = 2
+  end
+
+  it 'will not call `foo_changed` when `bar` is updated' do
+    expect(subject).not_to receive(:foo_changed)
+
+    subject.bar = 2
+  end
+
+  it 'will not call `foo_changed` if `old_value` and `new_value` are the same' do
+    subject.foo = 2
+
+    expect(subject).not_to receive(:foo_changed)
+
+    subject.foo = 2
+  end
+end

data/spec/simple_attr_writer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+class SimpleAttrWriter
+  attr_accessor :foo, :bar, :foo_changed => :foo_changed
+
+  def foo_changed(old_value, new_value); end
+end
+
+describe SimpleAttrWriter do
+  it 'will call `foo_changed` when `foo` is updated' do
+    expect(subject).to receive(:foo_changed).with(nil, 2)
+
+    subject.foo = 2
+  end
+
+  it 'will not call `foo_changed` when `bar` is updated' do
+    expect(subject).not_to receive(:foo_changed)
+
+    subject.bar = 2
+  end
+
+  it 'will not call `foo_changed` if `old_value` and `new_value` are the same' do
+    subject.foo = 2
+
+    expect(subject).not_to receive(:foo_changed)
+
+    subject.foo = 2
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+require File.expand_path('../../lib/better_attrs.rb', __FILE__)

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: better_attrs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan W. Zaleski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Enhances `attr_accessor` and `attr_writer` to allow the specification
+  of a callback to be invoked when an attribute value is changed. Ideal for cascading
+  updates or deployment scenarios where it is necessary to keep legacy values in sync
+  until a time that they can be safely removed.
+email:
+- JonathanZaleski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- better_attrs.gemspec
+- lib/better_attrs.rb
+- lib/better_attrs/class.rb
+- lib/better_attrs/version.rb
+- spec/attr_accessor_spec.rb
+- spec/attr_writer_spec.rb
+- spec/simple_attr_accessor_spec.rb
+- spec/simple_attr_writer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jzaleski/better_attrs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Enhances `attr_accessor` and `attr_writer` to allow the specification of
+  a callback to be invoked when an attribute value is changed.
+test_files:
+- spec/attr_accessor_spec.rb
+- spec/attr_writer_spec.rb
+- spec/simple_attr_accessor_spec.rb
+- spec/simple_attr_writer_spec.rb
+- spec/spec_helper.rb