presenter_object 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b2b81e23c06a961f66b04f603fd5e99dd7c9d19
+  data.tar.gz: 08f1c1059ad498a3c093acf8d890f2c9c8aaecee
+SHA512:
+  metadata.gz: 6615515a4ffaadb2f993bb7c3acf06dae12060e79ca82c741839d2fb93491c8654a60fa8d3f0a1461097c732bf065612774f0170027d56210ac514128c35c2a5
+  data.tar.gz: 2cae90ea5004842feb15d9f83735f4e8cf19c2430e3afe9c168a1369a018c993fc8e893c4169e47f41160332399c7524eeec9699de88ed766be8753d8dd2212f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/README.md

@@ -0,0 +1,66 @@
+# PresenterObject
+
+This is a simple presenter base class you can use to create model specific presenters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'presenter_object'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install presenter_object
+
+## Usage
+
+Given a model class:
+
+```ruby
+class User < ActiveRecord::Base
+   validates :first_name, presence: true # just to show one of the attributes of this model
+end
+```
+
+Create a subclass such as:
+
+```ruby
+class UserPresenter < PresenterObject::Base
+  presents :user
+
+  def formatted_phone_number
+    I18n.l phone_number, format: :fancy
+  end  
+end
+```
+
+Then wrap a model instance:
+
+```ruby
+@user = UserPresenter.new User.find(params[:id])
+```
+
+The `@user` presenter object can be used as if it were the model object. Then, just place all presentation methods in the presenter class and call them from the views.
+
+```ruby
+@user.class # => User
+@user.respond_to? :first_name # => true
+@user.formatted_phone_number # => "(555) 444-3322"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/DiegoSalazar/presenter_object.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "presenter_object"
+
+# 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/presenter_object/base.rb

@@ -0,0 +1,49 @@
+# Presenter superclass. Create your own presenter by sub-classing `PresenterObject::Base`
+# and declaring the name of the model it will present. 
+#
+# e.g:
+#
+#   class DocumentPresenter << PresenterObject::Base
+#     presents :document
+#
+#    .. add instance methods here ..
+#   end
+#
+# Create a presenter instance by giving it a model instance e.g:
+#
+#   document = DocumentPresenter.new Document.find(params[:id]) 
+#   document.sender # can call any document model methods...
+#   document.pretty_sender # ...as well as any presenter defined method
+#   document.class # is the wrapped object's class, helps it behave like models do in forms, link helpers etc.
+#
+class PresenterObject::Base
+  class << self
+    def presents(class_name)
+      @class_name = class_name.to_s.classify
+      presenters[@class_name] = self
+    end
+
+    def presented_class
+      @presented_class ||= @class_name.constantize
+    end
+
+    def presenters
+      @@presenters ||= {}
+    end
+  end
+
+  attr_reader :object, :class
+
+  def initialize(object)
+    @object, @class = object, object.class
+  end
+
+  def method_missing(name, *args, &block)
+    super unless object.respond_to? name
+    object.send name, *args, &block
+  end
+
+  def respond_to?(name, include_private = false)
+    object.respond_to? name, include_private or super
+  end
+end

data/lib/presenter_object/presentable.rb

@@ -0,0 +1,27 @@
+# Include this concern in a model class to easily wrap the model in a presenter e.g:
+# 
+# class Document < ActiveRecord::Base
+#   include PresenterObject::Presentable
+# end
+# 
+# Now turn any instance into a presenter-wrapped model e.g:
+# 
+# document = Document.find(params[:id]).presenterize
+#
+module PresenterObject::Presentable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def presenter_class
+      PresenterObject::Base.presenters.fetch name
+    end
+  end
+
+  def presenter_class
+    self.class.presenter_class
+  end
+
+  def presenterize
+    presenter_class.new self
+  end
+end

data/lib/presenter_object/version.rb

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

data/lib/presenter_object.rb

@@ -0,0 +1,6 @@
+require "presenter_object/version"
+
+module PresenterObject
+  autoload :Base, "presenter_object/base"
+  autoload :Presentable, "presenter_object/presentable"
+end

data/presenter_object.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'presenter_object/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "presenter_object"
+  spec.version       = PresenterObject::VERSION
+  spec.authors       = ["Diego Salazar"]
+  spec.email         = ["diego.salazar@kipusystems.com"]
+  spec.license       = "MIT"
+  spec.summary       = %q{Prsenter object base class.}
+  spec.description   = %q{Useful for wrapping model objects with presentation methods.}
+  spec.homepage      = "https://github.com/DiegoSalazar/presenter_object"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "activesupport", "~> 4.2"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: presenter_object
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diego Salazar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Useful for wrapping model objects with presentation methods.
+email:
+- diego.salazar@kipusystems.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/presenter_object.rb
+- lib/presenter_object/base.rb
+- lib/presenter_object/presentable.rb
+- lib/presenter_object/version.rb
+- presenter_object.gemspec
+homepage: https://github.com/DiegoSalazar/presenter_object
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Prsenter object base class.
+test_files: []