pardner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3673f62b248402a9a1603c49a9f322f743c93e61
+  data.tar.gz: e279b4447af6f22850ecb1d783dbb36970e8999c
+SHA512:
+  metadata.gz: 6e5f6651fc734784a3a955b82d7ca0dca7a9c6a0b961e3367331ffe86d419b4e2108ac58602e6cee8f64254b1f0ae1e920cbcfd4848fec2b934867138eb68a65
+  data.tar.gz: 5f6b1e8b156148bbe3d730f49361680a36608d56862d8f301fa3e4ba4a1294cf305ce70e15bf059271c59d5cb443a055a85254f997c2a7d069b7b2f645cdc700

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/*.log

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+
+# Allow 120 character line lengths
+LineLength:
+  Max: 100
+
+# Allow tabbed alignment of method args
+SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Don't require top-level documenation
+Documentation:
+  Enabled: false
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Metrics/MethodLength:
+  Max: 20

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  watch(dsl.ruby.lib_files) { dsl.rspec.spec_dir }
+  watch(dsl.rspec.spec_files)
+  watch(dsl.rspec.spec_helper) { dsl.rspec.spec_dir }
+  watch(dsl.rspec.spec_support) { dsl.rspec.spec_dir }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andy Hartford
+
+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,121 @@
+
+
+          .~~~~`\~~\
+         ;       ~~ \
+         |           ;
+     ,--------,______|---.
+    /          \-----`    \
+    `.__________`-_______-' _
+        _ __   __ _ _ __ __| |_ __   ___ _ __
+       | '_ \ / _` | '__/ _` | '_ \ / _ \ '__|
+       | |_) | (_| | | | (_| | | | |  __/ |
+       | .__/ \__,_|_|  \__,_|_| |_|\___|_|
+       |_|
+
+# pardner
+
+A decorator library for ActiveRecord that has features to fit in nicely with the ActiveModel world
+
+## Use cases
+
+1. Presenters for views
+2. Handle form params and translate them to what the modal understands
+3. Creating or updating multiple ActiveRecord models atomically
+4. Adding optional validations
+5. And more!
+
+## 1. Presenters
+
+A presenter can be used as an alternative to a view helper to add logic
+to a view. In this example we add a `description` method to a decorator
+for the view:
+
+    # app/models/conestoga_wagon.rb
+    class ConestogaWagon < ActiveRecord::Base
+      attr_accessor :wheels_count, :covered
+    end
+
+    # app/presenters/conestoga_wagon_presenter.rb
+    class ConestogaWagonPresenter < Pardner::Base
+      howdy_pardner ConestogaWagon
+
+      def description
+        covered_string = covered ? "covered" : "uncovered"
+        "a #{wheels_count} wheeled #{covered_string} wagon"
+      end
+    end
+
+    # app/view/conestoga_wagons/show.html.haml
+    ...
+    span.description= @conestoga_wagon.description
+    ...
+
+## 2. Handle form params
+
+In this example, the `GoldRush` model has separate `city` and `state`
+fields, but we want to present that to the user as a single form field.
+The decorator will split the incoming `location` param into `city` and
+`state` fields.
+
+    # app/models/gold_rush.rb
+    class GoldRush < ActiveRecord::Base
+      attr_accessor :city, :state
+    end
+
+    # app/decorators/gold_rush_form.rb
+    class GoldRushForm < Pardner::Base
+      howdy_pardner GoldRush
+
+      def location
+        "#{city}, #{state}"
+      end
+
+      def location=(val)
+        self.city, self.state = val.split ','
+      end
+    end
+
+    # app/controllers/gold_rushes_controller.rb
+    def new
+      @gold_rush = GoldRushForm.new GoldRush.new
+    end
+
+    # app/view/gold_rushes/new.html.haml
+    = form_for @gold_rush do |form|
+      form.text :location
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pardner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pardner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pardner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pardner"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pardner/base.rb

@@ -0,0 +1,141 @@
+require 'delegate'
+
+module Pardner
+  # A base class for creating an active model that decorate an active record
+  # model to add behavior. Common active record persistence methods are
+  # available and delegated to the decorated active record instance.
+  #
+  # To use:
+  #
+  # 1. create a subclass of Pardner::Base
+  # 2. call .pardner_config to configure things
+  # 3. override methods, add validations, add callbacks etc to get custom
+  #    behavior
+  #
+  # For example:
+  #
+  #   class BookDecorator < Pardner::Base
+  #     pardner_config Book
+  #
+  #     after_save :send_email
+  #
+  #     private
+  #
+  #     def send_email
+  #       BookMailer.saved_book(self).deliver_now
+  #     end
+  #   end
+  #
+  class Base < SimpleDelegator
+    extend ActiveModel::Callbacks
+    include ActiveModel::Model
+    include ActiveModel::Validations
+    include ActiveModel::Validations::Callbacks
+
+    class_attribute :pardner_config
+
+    define_model_callbacks \
+      :destroy,
+      :save,
+      :validation
+
+    # Configure the decorator by calling this. Pass in one or many classes
+    # that will be delegated to. Define a block which'll be passed a
+    # configuration object to configure more things.
+    def self.howdy_pardner(decorated_class)
+      self.pardner_config = pardner_config ? pardner_config.deep_dup : Config.new
+      pardner_config.decorated_class = decorated_class
+      nil
+    end
+
+    def initialize(decorated_record)
+      __setobj__ decorated_record
+    end
+
+    # Returns the decorated record
+    def decorated_record
+      __getobj__
+    end
+
+    # Returns the decorated record deeply, ignoring any nested decorators.
+    def decorated_record_deep
+      __getobj__.is_a?(Pardner::Base) ? __getobj__.decorated_record_deep : __getobj__
+    end
+
+    def self.model_name
+      if pardner_config.try(:decorated_class)
+        pardner_config.decorated_class.model_name
+      else
+        super
+      end
+    end
+
+    def [](attr)
+      send(attr)
+    end
+
+    def []=(attr, value)
+      send("#{attr}=", value)
+    end
+
+    def attributes=(attrs = {})
+      attrs.each do |attr, value|
+        public_send "#{attr}=", value
+      end
+    end
+
+    def save
+      valid? or return false
+
+      status = ActiveRecord::Base.transaction do
+        run_callbacks(:save) { super }
+      end
+
+      status == true
+    end
+
+    def save!
+      save or fail InvalidModel, "Validation failed: #{errors.full_messages.join(',')}"
+    end
+
+    def destroy
+      ActiveRecord::Base.transaction do
+        run_callbacks(:destroy) { super }
+      end
+    end
+
+    def update(attrs = {})
+      self.attributes = attrs
+      save
+    end
+    alias_method :update_attributes, :update
+
+    def update!(attrs = {})
+      update attrs or
+        fail InvalidModel, "Validation failed: #{errors.full_messages.join(',')}"
+    end
+    alias_method :update_attributes!, :update!
+
+    def valid?
+      run_callbacks :validation do
+        if super && __getobj__.valid?
+          true
+        else
+          __getobj__.errors.each do |attr, msg|
+            errors.add attr, msg
+          end
+
+          false
+        end
+      end
+    end
+
+    def persisted?
+      decorated_record.persisted?
+    end
+
+    def new_record?
+      !persisted?
+    end
+  end
+end

data/lib/pardner/config.rb

@@ -0,0 +1,5 @@
+module Pardner
+  class Config
+    attr_accessor :decorated_class
+  end
+end

data/lib/pardner/version.rb

@@ -0,0 +1,3 @@
+module Pardner
+  VERSION = "0.1.0"
+end

data/lib/pardner.rb

@@ -0,0 +1,11 @@
+require 'active_model'
+require 'active_record'
+require 'active_support/all'
+
+require 'pardner/version'
+require 'pardner/config'
+require 'pardner/base'
+
+module Pardner
+  class InvalidModel < StandardError; end
+end

data/pardner.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pardner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pardner'
+  spec.version       = Pardner::VERSION
+  spec.authors       = ['Andy Hartford']
+  spec.email         = ['andy.hartford@cohealo.com']
+
+  spec.summary       = 'A decorator library for ActiveRecord'
+  spec.description   = 'A decorator library for ActiveRecord that has features to fit in nicely with the ActiveModel world'
+  spec.homepage      = 'https://github.com/ajh/pardner'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+    .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activemodel',    '~> 4.2'
+  spec.add_runtime_dependency 'activerecord',   '~> 4.2'
+  spec.add_runtime_dependency 'activesupport',  '~> 4.2'
+
+  spec.add_development_dependency 'bundler',           '~> 1.10'
+  spec.add_development_dependency 'rake',              '~> 10.0'
+  spec.add_development_dependency 'rspec',             '~> 3'
+  spec.add_development_dependency 'rspec-its',         '~> 1'
+  spec.add_development_dependency 'database_cleaner',  '~> 1.5'
+  spec.add_development_dependency 'rubocop',           '~> 0.35'
+  spec.add_development_dependency 'sqlite3',           '~> 1.3'
+
+  # guard stuff
+  spec.add_development_dependency 'guard-rspec',  '~> 4.6'
+  spec.add_development_dependency 'rb-fsevent',   '~> 0.9'
+  spec.add_development_dependency 'rb-inotify',   '~> 0.9'
+  spec.add_development_dependency 'ruby_gntp',    '~> 0.3'
+end

metadata

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: pardner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Hartford
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: A decorator library for ActiveRecord that has features to fit in nicely
+  with the ActiveModel world
+email:
+- andy.hartford@cohealo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pardner.rb
+- lib/pardner/base.rb
+- lib/pardner/config.rb
+- lib/pardner/version.rb
+- log/.gitkeep
+- pardner.gemspec
+homepage: https://github.com/ajh/pardner
+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: A decorator library for ActiveRecord
+test_files: []