attr_delegated 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4df2326eae33ba4f3b3fa5ac8c2e6c849171d5d0
+  data.tar.gz: 7df9c505db00ff38cccbaa5197188f245c342b09
+SHA512:
+  metadata.gz: 5a88e90935e2a913bda6c6615f6ebca9f3d31373bde076469e80a1a1520a16d1087f7d40141771730f8587379b64e3df6218148a3bdc2af0b4862b3eda037a5a
+  data.tar.gz: b9a7ced03a76304447ed856210221e31bbf71c3597961e362388e62c4e537e9e8a758ead861334665f209b89bd772f2f8c1854bfebfce49fb15dd6109b0406f2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.pryrc

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'attr_delegated'
+
+class Bar
+  attr_accessor :baz, :quux
+
+  attr_reader :value
+
+  def initialize(value = 9000)
+    @value = value
+
+    @baz = value.to_s * 2
+    @quux = value.to_s * 3
+  end
+end
+
+class Foo
+  extend AttrDelegated
+
+  attr_delegated :baz, :quux, to: :bar
+
+  attr_reader :bar
+
+  def initialize(new_bar = 9000)
+    @bar = Bar.new new_bar
+  end
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexa Grey
+
+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,29 @@
+# AttrDelegated
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'attr_delegated'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attr_delegated
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/attr_delegated/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/attr_delegated.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attr_delegated/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attr_delegated"
+  spec.version       = AttrDelegated::VERSION
+  spec.authors       = ["Alexa Grey"]
+  spec.email         = ["devel@mouse.vc"]
+  spec.summary       = %q{Delegate an ActiveModel attribute and all its meta methods to another model.}
+  spec.description   = %q{Delegate an ActiveModel attribute and all its meta methods to another model.}
+  spec.homepage      = "https://github.com/scryptmouse/attr_delegated"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency "activesupport", ">= 3.2.0", "< 5"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+end

data/lib/attr_delegated.rb

@@ -0,0 +1,21 @@
+require 'active_support/all'
+require 'attr_delegated/options'
+require 'attr_delegated/version'
+
+module AttrDelegated
+  # Delegate an ActiveModel attribute and all its meta methods to another model,
+  # e.g. in addition to the reader: the writer, predicate, and "changed?" methods as well.
+  #
+  # @param [Array] attrs
+  # @param [Hash] options (see AttrDelegated::Options#initialize)
+  # @return [void]
+  def attr_delegated(*attrs, **options)
+    opts = AttrDelegated::Options.new attrs, options 
+
+    delegate *opts
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend AttrDelegated
+end

data/lib/attr_delegated/options.rb

@@ -0,0 +1,150 @@
+module AttrDelegated
+  class Options
+    METHODS = {
+      reader:           "%s",
+      writer:           "%s=",
+      predicate:        "%s?",
+      type_cast:        "%s_before_type_cast",
+      dirty: %w[
+        %s_change
+        %s_changed?
+        %s_will_change!
+        %s_was
+        reset_%s!
+      ]
+    }
+
+    GROUPS = METHODS.keys
+
+    DELEGATE_OPTION_KEYS = %i[to allow_nil prefix]
+
+    DEFAULTS = Hash[GROUPS.zip([true] * GROUPS.length)]
+
+    # @!attribute [r] attributes
+    # @api private
+    # @return [Array<String, Symbol>]
+    attr_reader :attributes
+
+    # @!attribute [r] raw_options
+    # @api private
+    # @return [Hash]
+    attr_reader :raw_options
+
+    UNIQUE_KEYS = %i[only skip]
+
+    # @param [Array<String, Symbol>] attributes
+    # @param [Hash] raw_options
+    # @option raw_options [Symbol, String] :to **Must be set!** Passed to delegate
+    # @option raw_options [Boolean] :allow_nil Passed to `delegate`
+    # @option raw_options [Boolean, String, Symbol] :prefix Passed to `delegate`
+    # @option raw_options [Boolean] :reader (true) Whether to delegate the reader
+    # @option raw_options [Boolean] :writer (true) Whether to delegate the writer
+    # @option raw_options [Boolean] :predicate (true) Whether to delegate the predicate
+    # @option raw_options [Boolean] :type_cast (true) Whether to delegate the `before_type_cast` method
+    # @option raw_options [Boolean] :dirty (true) Whether to delegate the "dirty" methods
+    # @option raw_options [Array, Symbol] :only Can delegate only certain methods, incompatible with `:without`
+    # @option raw_options [Array, Symbol] :skip Can skip delegate only certain methods
+    def initialize(attributes, raw_options = {})
+      @attributes   = Array( attributes )
+      @raw_options  = raw_options.reverse_merge DEFAULTS
+
+      check_for_attributes!
+      check_for_to!
+      check_for_unique_key_conflict!
+    end
+
+    # @!attribute [r] delegated_methods
+    # @return [Array<Symbol>]
+    def delegated_methods
+      @delegated_methods ||= attributes.flat_map do |attribute|
+        delegated_method_formats.map do |format|
+          format % attribute
+        end
+      end
+    end
+
+    def to_a
+      [*delegated_methods, options_for_delegate]
+    end
+
+    private
+    # @raise [ArgumentError] unless 1 or more attributes provided
+    # @return [void]
+    def check_for_attributes!
+      raise ArgumentError, "must provide attributes to delegate!" if attributes.none?
+    end
+
+    # @raise [ArgumentError] unless option `:to` is set
+    # @return [void]
+    def check_for_to!
+      raise ArgumentError, "must define `:to` to delegate!" unless option? :to
+    end
+
+    # @raise [ArgumentError] if `:only` and `:skip` are both set
+    # @return [void]
+    def check_for_unique_key_conflict!
+      if unique_keys.many?
+        quoted_unique_keys = unique_keys.map { |k| "`%s`" % k }.to_sentence
+
+        raise ArgumentError, "cannot set #{quoted_unique_keys} at the same time"
+      end
+    end
+
+    # @return [Array<String>]
+    def delegated_method_formats
+      @delegated_method_formats ||= METHODS.values_at(*delegates).flatten
+    end
+
+    # @!attribute [r] delegates
+    # @api private
+    # @return [Array<Symbol>]
+    def delegates
+      @delegates ||= detect_delegates!
+    end
+
+    # @return [Array]
+    def detect_delegates!
+      case unique_key
+      when :only then GROUPS & unique_key_options
+      when :skip then GROUPS - unique_key_options
+      else
+        GROUPS.select { |group| option? group }
+      end
+    end
+
+    # @return [Boolean]
+    def option?(key)
+      raw_options.key?(key) && raw_options[key].presence
+    end
+
+    # @!attribute [r] options_for_delegate
+    # @api private
+    # @return [Hash]
+    def options_for_delegate
+      raw_options.slice *DELEGATE_OPTION_KEYS
+    end
+
+    # @!attribute [r] unique_key_options
+    # @api private
+    # @return [Array<Symbol>]
+    def unique_key_options
+      @unique_key_options ||= Array(raw_options[unique_key])
+    end
+
+    # @!attribute [r] unique_keys
+    # @api private
+    # @return [Array<Symbol>]
+    def unique_keys
+      @unique_keys ||= raw_options.keys & UNIQUE_KEYS
+    end
+
+    # @!attribute [r] unique_key
+    # @api private
+    # @return [Symbol, nil]
+    def unique_key
+      @unique_key = unique_keys.first unless defined?(@unique_key)
+
+      @unique_key
+    end
+  end
+end

data/lib/attr_delegated/version.rb

@@ -0,0 +1,3 @@
+module AttrDelegated
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: attr_delegated
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexa Grey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Delegate an ActiveModel attribute and all its meta methods to another
+  model.
+email:
+- devel@mouse.vc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attr_delegated.gemspec
+- lib/attr_delegated.rb
+- lib/attr_delegated/options.rb
+- lib/attr_delegated/version.rb
+homepage: https://github.com/scryptmouse/attr_delegated
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Delegate an ActiveModel attribute and all its meta methods to another model.
+test_files: []
+has_rdoc: