active_attr_extended 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d74bf1de85a947c2a3db19d89c6140f9d6ae713
+  data.tar.gz: 92b44b2e16e8b5c76e9b9d6ebb2df92aabaedea6
+SHA512:
+  metadata.gz: 520d3034332dc9e3de7e967118930b9978e343e7a06aa75f98e1c4e583b429965ac84d7a31e4424cf65e390528698c19644075f3517bf2dc37f0f8aede79fe61
+  data.tar.gz: 6c54a8435e28008f9796741c9d95b915936e4a30dc4b8aaa6292e460796192585f1bf468b6845138d70630d8dd6052e6ce4f59d695a2988c7f252689402c1748

data/.gitignore

@@ -0,0 +1,30 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+#various artifacts
+spec/examples.txt
+
+# scm revert files
+**.orig
+
+# Mac finder artifacts
+.DS_Store
+
+# Netbeans project directory
+/nbproject/
+
+# RubyMine project files
+.idea
+
+# Textmate project files
+/*.tmproj
+
+# vim artifacts
+**.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jason Haruska
+
+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,260 @@
+# ActiveAttrExtended
+
+[![Build History][travis badge]][travis]
+[![Code Climate][codeclimate badge]][codeclimate]
+
+ActiveAttrExtended is an extension of ActiveAttr to include Arrays and Hashes as
+valid attribute types.
+
+ActiveAttr is a set of modules that makes it easy to create plain old ruby
+models with functionality found in ORMs, like ActiveRecord, without
+reinventing the wheel. Think of ActiveAttr as the stuff ActiveModel left out.
+
+## ActiveAttr vs ActiveAttrExtended
+
+ActiveAttrExtended is a superset of functionality of ActiveAttr. The gem versions
+in ActiveAttrExtended match the sister version in ActiveAttr where possible.
+
+The biggest difference is the ability to use Arrays and Hashes as attribute types.
+
+* [ActiveAttr API Documentation][aa_api]
+* [Extended API Documentation][api]
+
+[api]: http://rubydoc.info/gems/active_attr_extended
+[aa_api]: http://rubydoc.info/gems/active_attr
+[codeclimate badge]: https://codeclimate.com/github/haruska/active_attr_extended.png
+[codeclimate]: https://codeclimate.com/github/haruska/active_attr_extended
+[rubygems]: http://rubygems.org/gems/active_attr_extended
+[protected_attributes]: https://github.com/rails/protected_attributes
+[strong_parameters]: https://github.com/rails/strong_parameters
+[travis badge]: https://secure.travis-ci.org/haruska/active_attr_extended.png?branch=master
+[travis]: http://travis-ci.org/haruska/active_attr_extended
+
+## Modules ##
+
+### Attributes ###
+
+Including the Attributes module into your class gives you a DSL for defining
+the attributes of your model.
+
+    class Person
+      include ActiveAttr::Attributes
+
+      attribute :first_name
+      attribute :last_name
+    end
+
+    person = Person.new
+    person.first_name = "Chris"
+    person.last_name = "Griego"
+    person.attributes #=> {"first_name"=>"Chris", "last_name"=>"Griego"}
+
+#### AttributeDefaults ####
+
+Including the AttributeDefaults module into your class builds on Attributes by
+allowing defaults to be declared with attributes.
+
+    class Person
+      include ActiveAttr::AttributeDefaults
+
+      attribute :first_name, :default => "John"
+      attribute :last_name, :default => "Doe"
+    end
+
+    person = Person.new
+    person.first_name #=> "John"
+    person.last_name #=> "Doe"
+
+#### QueryAttributes ####
+
+Including the QueryAttributes module into your class builds on Attributes by
+providing instance methods for querying your attributes.
+
+    class Person
+      include ActiveAttr::QueryAttributes
+
+      attribute :first_name
+      attribute :last_name
+    end
+
+    person = Person.new
+    person.first_name = "Chris"
+    person.first_name? #=> true
+    person.last_name? #=> false
+
+#### TypecastedAttributes ####
+
+Including the TypecastedAttributes module into your class builds on Attributes
+by providing type conversion for your attributes.
+
+    class Person
+      include ActiveAttr::TypecastedAttributes
+      attribute :age, :type => Integer
+      attribute :family, :type => Array
+    end
+
+    person = Person.new
+    person.age = "29"
+    person.age #=> 29
+    person.family = ["Peter", "Molly"]
+    person.family #=> ["Peter", "Molly]
+
+### BasicModel ###
+
+Including the BasicModel module into your class gives you the bare minimum
+required for your model to meet the ActiveModel API requirements.
+
+    class Person
+      include ActiveAttr::BasicModel
+    end
+
+    Person.model_name.plural #=> "people"
+    person = Person.new
+    person.valid? #=> true
+    person.errors.full_messages #=> []
+
+### BlockInitialization ###
+
+Including the BlockInitialization module into your class will yield the model
+instance to a block passed to when creating a new instance.
+
+    class Person
+      include ActiveAttr::BlockInitialization
+      attr_accessor :first_name, :last_name
+    end
+
+    person = Person.new do |p|
+      p.first_name = "Chris"
+      p.last_name = "Griego"
+    end
+
+    person.first_name #=> "Chris"
+    person.last_name #=> "Griego"
+
+### Logger ###
+
+Including the Logger module into your class will give you access to a
+configurable logger in model classes and instances. Your preferred logger can
+be configured on an instance, subclass, class, parent class, and globally by
+setting ActiveAttr::Logger.logger. When using Rails, the Rails framework
+logger will be configured by default.
+
+    class Person
+      include ActiveAttr::Logger
+    end
+
+    Person.logger = Logger.new(STDOUT)
+    Person.logger? #=> true
+    Person.logger.info "Logging an informational message"
+
+    person = Person.new
+    person.logger? #=> true
+    person.logger = Logger.new(STDERR)
+    person.logger.warn "Logging a warning message"
+
+### MassAssignment ###
+
+Including the MassAssignment module into your class gives you methods for bulk
+initializing and updating the attributes of your model. Any unknown attributes
+are silently ignored.
+
+    class Person
+      include ActiveAttr::MassAssignment
+      attr_accessor :first_name, :last_name, :age
+    end
+
+    person = Person.new(:first_name => "Christopher", :last_name => "Griego")
+    person.attributes = { :first_name => "Chris", :age => 21 }
+    person.first_name #=> "Chris"
+    person.last_name #=> "Griego"
+
+MassAssignment supports mass assignment security/sanitization if a sanitizer
+is included in the model. If using Rails 4.0, include ActiveModel's forbidden
+attributes protection module to get support for strong parameters.
+
+    class Person
+      include ActiveAttr::MassAssignment
+      include ActiveModel::ForbiddenAttributesProtection
+      attr_accessor :first_name, :last_name
+    end
+
+    person = Person.new(ActionController::Parameters.new({
+      :first_name => "Chris",
+      :last_name => "Griego",
+    }).permit(:first_name))
+    person.first_name #=> "Chris"
+    person.last_name #=> nil
+
+If using Rails 3.x or the [Protected Attributes gem][protected_attributes],
+include ActiveModel's mass assignment security module to get support for
+protected attributes, including support for mass assignment roles.
+
+    class Person
+      include ActiveAttr::MassAssignment
+      include ActiveModel::MassAssignmentSecurity
+      attr_accessor :first_name, :last_name
+      attr_protected :last_name
+    end
+
+    person = Person.new(:first_name => "Chris", :last_name => "Griego")
+    person.first_name #=> "Chris"
+    person.last_name #=> nil
+
+If using the [Strong Parameters gem][strong_parameters] with Rails 3.2,
+include the forbidden attributes protection module after including
+the mass assignment security module.
+
+    class Person
+      include ActiveAttr::MassAssignment
+      include ActiveModel::MassAssignmentSecurity
+      include ActiveModel::ForbiddenAttributesProtection
+    end
+
+### Serialization ###
+
+The Serialization module is a shortcut for incorporating ActiveModel's
+serialization functionality into your model with one include.
+
+    class Person
+      include ActiveAttr::Serialization
+    end
+
+### Model ###
+
+The Model module is a shortcut for incorporating the most common model
+functionality into your model with one include. All of the above modules
+are included when you include Model.
+
+    class Person
+      include ActiveAttr::Model
+    end
+
+## Integrations ##
+
+### Ruby on Rails ###
+
+When using ActiveAttrExtended inside a Rails application, ActiveAttrExtended will configure
+your models' default logger to use the Rails logger automatically. Just
+include ActiveAttrExtended in your Gemfile.
+
+    gem "active_attr_extended"
+
+### RSpec ###
+
+ActiveAttr comes with matchers and RSpec integration to assist you in testing
+your models. The matchers also work with compatible frameworks like Shoulda.
+
+    require "active_attr/rspec"
+
+    describe Person do
+      it { is.expected_to have_attribute(:first_name).of_type(String).with_default_value_of("John") }
+    end
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/haruska/active_attr_extended.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--format progress"
+end
+
+task :default => :spec

data/active_attr_extended.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_attr_extended/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_attr_extended"
+  spec.version       = ActiveAttrExtended::VERSION
+  spec.authors       = ["Jason Haruska"]
+  spec.email         = ["jason@haruska.com"]
+
+  spec.summary       = "What ActiveModel left out (including Collections)"
+  spec.description   = "An extension of the active_attr gem, adding Arrays and Hashes as valid attribute types. Create plain old ruby models without reinventing the wheel."
+  spec.homepage      = "https://github.com/haruska/active_attr_extended"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "active_attr", ">= 0.6.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_attr_extended"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_attr_extended/typecasting/array_typecaster.rb

@@ -0,0 +1,40 @@
+require 'json'
+
+module ActiveAttrExtended
+  module Typecasting
+    # Typecasts an Object to an Array
+    #
+    # @example Usage
+    #   ArrayTypecaster.new.call(1) # => [1]
+    #
+    # @since 0.6.0
+    class ArrayTypecaster
+      # Typecasts an Object to an Array
+      #
+      # Will typecast any Object except nil to an Array, first by attempting to
+      # call `#to_a`, then by wrapping `value` in an Array (`[value]`).
+      #
+      # @example Usage
+      #   ArrayTypecaster.new.call(1) # => [1]
+      #
+      # @param [Object] value The object to typecast
+      #
+      # @return [Array, nil] The result of typecasting
+      #
+      # @since 0.6.0
+      def call(value)
+        #treat incoming strings as serialized JSON
+        value = JSON::parse(value) if value.is_a? String
+
+        if value.nil?
+          nil
+        elsif value.respond_to? :to_a
+          value.to_a
+        else
+          [value]
+        end
+      end
+    end
+  end
+end
+    

data/lib/active_attr_extended/typecasting/hash_typecaster.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module ActiveAttrExtended
+  module Typecasting
+    # Typecasts an Object to a Hash
+    #
+    # @example Usage
+    #   HashTypecaster.new.call(1) # => [1]
+    #
+    # @since 0.6.0
+    class HashTypecaster
+      # Typecasts an Object to a Hash
+      #
+      # Will typecast JSON or Hashes into a Hash
+      #
+      # @example Usage
+      #   HashTypecaster.new.call(nil) # => {}
+      #   HashTypecaster.new.call({:x => :y}) # => {:x => :y}
+      #   HashTypecaster.new.call({:x => :y}.to_json) # => {:x => :y}
+      #
+      # @param [Object] value The object to typecast
+      #
+      # @return [Hash, nil] The result of typecasting
+      #
+      # @since 0.6.0
+      def call(value)
+        #treat incoming strings as serialized JSON
+        value = JSON::parse(value) if value.is_a? String
+        value.is_a?(Hash) ? value : {}
+      end
+    end
+  end
+end

data/lib/active_attr_extended/version.rb

@@ -0,0 +1,3 @@
+module ActiveAttrExtended
+  VERSION = "0.9.0"
+end

data/lib/active_attr_extended.rb

@@ -0,0 +1,27 @@
+require "active_attr"
+require "active_attr_extended/version"
+require "active_attr_extended/typecasting/array_typecaster"
+require "active_attr_extended/typecasting/hash_typecaster"
+
+module ActiveAttrExtended; end
+
+
+# Reassign the typecaster mapping to include collections
+ActiveAttr::Typecasting.module_eval { send(:remove_const, :TYPECASTER_MAP) }
+module ActiveAttr
+  module Typecasting
+    # @private
+    TYPECASTER_MAP = {
+        Array      => ::ActiveAttrExtended::Typecasting::ArrayTypecaster,
+        BigDecimal => BigDecimalTypecaster,
+        Boolean    => BooleanTypecaster,
+        Date       => DateTypecaster,
+        DateTime   => DateTimeTypecaster,
+        Float      => FloatTypecaster,
+        Hash       => ::ActiveAttrExtended::Typecasting::HashTypecaster,
+        Integer    => IntegerTypecaster,
+        Object     => ObjectTypecaster,
+        String     => StringTypecaster
+    }.freeze
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: active_attr_extended
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Jason Haruska
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: An extension of the active_attr gem, adding Arrays and Hashes as valid
+  attribute types. Create plain old ruby models without reinventing the wheel.
+email:
+- jason@haruska.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_attr_extended.gemspec
+- bin/console
+- bin/setup
+- lib/active_attr_extended.rb
+- lib/active_attr_extended/typecasting/array_typecaster.rb
+- lib/active_attr_extended/typecasting/hash_typecaster.rb
+- lib/active_attr_extended/version.rb
+homepage: https://github.com/haruska/active_attr_extended
+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.5.1
+signing_key: 
+specification_version: 4
+summary: What ActiveModel left out (including Collections)
+test_files: []