tuxedo_decorate 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2be8003b952d96220499facd10d37c7de8acf51
-  data.tar.gz: 22b2839a94e764104c725a961b43d2f48a5ee7e3
+  metadata.gz: 28fac7d01876b72c56782e3d42056e8f73b8443d
+  data.tar.gz: 761815fecefe9b4cc6b52e5ab03714990c0d66d3
 SHA512:
-  metadata.gz: 5f4aa5d568b6f6258fdbbdf8d36b8a0519ee627bc83b0baf161b810cecba34fa97273afd746cb3c052dbb79e989358866ae424c66208f0a581823f83cb294193
-  data.tar.gz: 7aed0a729b639a67d7eb2b672f7bfb1bd1d36ed75dd33c4c10ff04994f2cc9cb4525429a22c3b3d49efba3297225a3359b4cb5530d21cf0e680b057c954f6814
+  metadata.gz: 7cbadf52a72f779634dfb3e169bb0d91d37c1b040a2e9877c9cbf640907089d393feeec600ad39b65c25bc84a92bde21ab12bfb980aa14a74f57ec6baa196cd0
+  data.tar.gz: e5991af893557e64301feb44803c0f5e442786bad9dcf72e931366e1eda71dcbd388a714976a123907b1f0011237a297d5f0a5616f325fcc0aa2d917204a08bd

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+    - 'bin/*'

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-12-23 09:36:21 +0100 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 11
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 124
+
+# Offense count: 5
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,12 +1,30 @@
 language: ruby
+cache: bundler
 sudo: false
 rvm:
-  - 2.2.0
-  - 2.2.4
+  - 2.0.0
+  - 2.2
+  - ruby-head
+  - jruby-9.0.1.0
+  - rbx-2
+env:
+  - JRUBY_OPTS="-Xcli.debug=true --debug"
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-2
+  fast_finish: true
+before_install: gem update --remote bundler
+install:
+  - bundle install --retry=3
 gemfile:
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_stable.gemfile
-script: "bundle exec rake spec"
+script:
+  - 'bundle exec rake spec'
+  - 'bundle exec rubocop'
 addons:
   code_climate:
     repo_token: 344f2a60a2920e96f71877b87829836b01a44e1e94463cde54e2c54e8f389f79

data/Appraisals

@@ -1,3 +1,13 @@
+appraise "rails-4.0" do
+  gem 'activesupport', '4.0.0'
+  gem 'railties', '4.0.0'
+end
+
+appraise "rails-4.1" do
+  gem 'activesupport', '4.1.0'
+  gem 'railties', '4.1.0'
+end
+
 appraise "rails-4.2" do
   gem 'activesupport', '4.2.0'
   gem 'railties', '4.2.0'

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+## Unreleased
+- Add your entry here!
+
+## v0.3.0
+- The born of the changelog
+- Refactored Tuxedo to not use `AS::Concern`, this allows to support rails 4.0 and up.
+- Improved CI builds
+- Added rubocop
+
+## v0.2.0
+- RubyGems release
+- Added specs
+- Added travis support
+
+## v0.1.0 - unreleased
+- Initial POC from our Main application
+- Code Style and Naming from [@mcls](https://github.com/mcls)

data/Gemfile

@@ -2,3 +2,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in tuxedo.gemspec
 gemspec
+
+gem 'rake', '~> 10.1'
+gem 'rspec', '~> 3.4.0'
+gem 'yard', '~> 0.8'
+gem 'simplecov', '~> 0.10'
+gem 'appraisal', '~> 2.1.0'
+gem 'rubocop', '~> 0.35.0'
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+end

data/README.md

@@ -2,7 +2,7 @@
 [![Build Status](https://travis-ci.org/playpasshq/tuxedo.svg)](https://travis-ci.org/playpasshq/tuxedo)
 [![Code Climate](https://codeclimate.com/github/playpasshq/tuxedo/badges/gpa.svg)](https://codeclimate.com/github/playpasshq/tuxedo)
 [![Inline docs](http://inch-ci.org/github/playpasshq/tuxedo.png)](http://inch-ci.org/github/playpasshq/tuxedo)
-[![Gem Version](https://badge.fury.io/rb/tuxedo-decorate.svg)](https://badge.fury.io/rb/tuxedo-decorate)
+[![Gem Version](https://badge.fury.io/rb/tuxedo_decorate.svg)](https://badge.fury.io/rb/tuxedo_decorate)
 
 Tuxedo Decorate provides an easy to use `Presenter` layer on top of Rails views.
 It does not make any assumptions about your underline object or uses black
@@ -10,7 +10,7 @@ magic voodoo code to determine your ActiveRecord Relations.
 
 ## Installation
 
-Currently only rails 4.2 and up is supported and a ruby version of 2.2.0 or higher.
+Currently rails 4.0 or higher and ruby version of 2.0.0 or higher are supported.
 Add this line to your application's Gemfile:
 
 ```ruby

data/Rakefile

@@ -1,9 +1,28 @@
-require "rubygems"
-require "bundler/setup"
-Bundler.require
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
 
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+desc 'Run RSpec with code coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+task default: [:spec, :rubocop]
 
-task default: :spec
+require 'yard'
+YARD::Rake::YardocTask.new

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "tuxedo"
+require 'bundler/setup'
+require 'tuxedo'
 
 # 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.
@@ -10,5 +10,5 @@ require "tuxedo"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 10.1"
+gem "rspec", "~> 3.4.0"
+gem "yard", "~> 0.8"
+gem "simplecov", "~> 0.10"
+gem "appraisal", "~> 2.1.0"
+gem "rubocop", "~> 0.35.0"
+gem "activesupport", "4.0.0"
+gem "railties", "4.0.0"
+
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 10.1"
+gem "rspec", "~> 3.4.0"
+gem "yard", "~> 0.8"
+gem "simplecov", "~> 0.10"
+gem "appraisal", "~> 2.1.0"
+gem "rubocop", "~> 0.35.0"
+gem "activesupport", "4.1.0"
+gem "railties", "4.1.0"
+
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -2,7 +2,17 @@
 
 source "https://rubygems.org"
 
+gem "rake", "~> 10.1"
+gem "rspec", "~> 3.4.0"
+gem "yard", "~> 0.8"
+gem "simplecov", "~> 0.10"
+gem "appraisal", "~> 2.1.0"
+gem "rubocop", "~> 0.35.0"
 gem "activesupport", "4.2.0"
 gem "railties", "4.2.0"
 
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
 gemspec :path => "../"

data/gemfiles/rails_stable.gemfile

@@ -2,7 +2,17 @@
 
 source "https://rubygems.org"
 
+gem "rake", "~> 10.1"
+gem "rspec", "~> 3.4.0"
+gem "yard", "~> 0.8"
+gem "simplecov", "~> 0.10"
+gem "appraisal", "~> 2.1.0"
+gem "rubocop", "~> 0.35.0"
 gem "activesupport", "4.2.5"
 gem "railties", "4.2.5"
 
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+end
+
 gemspec :path => "../"

data/lib/tuxedo/action_view/helpers.rb

@@ -9,10 +9,10 @@ module Tuxedo
     #   prac(instance, method, *args)
     #
     module Helpers
-
-      # We can use this to give a block and wrap all the presenter methods in the block
-      # This shows clearly that we are using a presenter without the explicit assign statement
-      # Some magic happens to initiate a new presenter with the model and the view context
+      # We can use this to give a block and wrap all the presenter methods
+      # in the block. This shows clearly that we are using a presenter
+      # without the explicit assign statement. Some magic happens to initiate
+      # a new presenter with the model and the view context
       #
       # @param model[Object] any type of object that needs to be presented
       # @param klass [KlassName] a different presenter klass

data/lib/tuxedo/version.rb

@@ -1,3 +1,3 @@
 module Tuxedo
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'.freeze
 end

data/lib/tuxedo.rb

@@ -1,6 +1,5 @@
 require 'bundler/setup'
 require 'tuxedo/version'
-require 'active_support/concern'
 require 'active_support/inflector'
 require 'active_support/core_ext/module/delegation'
 require 'charlatan'
@@ -27,9 +26,7 @@ require 'tuxedo/railtie' if defined?(Rails)
 #   end
 #
 module Tuxedo
-  extend ActiveSupport::Concern
-
-  included do
+  module InstanceMethods
     include Charlatan.new(:object)
 
     # Initializes a new Tuxedo class using the to decorate object and the view context
@@ -41,9 +38,28 @@ module Tuxedo
       @view_context = view_context
       self.class.setup_alias_method
     end
+
+    # Helper method that delegates to the view context
+    # this allows you to call the url helpers from Rails
+    #
+    #   _h.link_to ...
+    #
+    # @return [ActionView::Context]
+    #
+    def _h
+      @view_context
+    end
+
+    # Define delegations of our prac helper to the view context, allows to call prac inside the
+    # presenters
+    delegate(:prac, to: :_h)
+
+    # These methods are already defined on Object by default or by rails, so we
+    # have to explicitly delegate them to the model.
+    delegate(:to_param, to: :object)
   end
 
-  class_methods do
+  module ClassMethods
     # Alias method name for accessing the original object
     # Defaults to guessing the name from the class
     #
@@ -70,22 +86,12 @@ module Tuxedo
     end
   end
 
-  # Helper method that delegates to the view context
-  # this allows you to call the url helpers from Rails
-  #
-  #   _h.link_to ...
+  # When included, extend the {ClassMethods} and include the {InstanceMethods}
   #
-  # @return [ActionView::Context]
+  # @param [Klass] base
   #
-  def _h
-    @view_context
+  def self.included(base)
+    base.send(:include, InstanceMethods)
+    base.extend(ClassMethods)
   end
-
-  # Define delegations of our prac helper to the view context, allows to call prac inside the
-  # presenters
-  delegate(:prac, to: :_h)
-
-  # These methods are already defined on Object by default or by rails, so we
-  # have to explicitly delegate them to the model.
-  delegate(:to_param, to: :object)
 end

data/spec/helpers/helpers_spec.rb

@@ -6,29 +6,30 @@ RSpec.describe Tuxedo::ActionView::Helpers do
   describe 'presenter_for' do
     subject { helper.presenter_for(Dummy.new) }
 
-    context "when providing instance" do
+    context 'when providing instance' do
       specify { expect(subject).to be_an_instance_of(DummyPresenter) }
     end
 
-    context "when providing a different instance" do
+    context 'when providing a different instance' do
       subject { helper.presenter_for(Dummy.new, Dummy2Presenter) }
       specify { expect(subject).to be_an_instance_of(Dummy2Presenter) }
     end
 
-    context "when provided object is nil" do
+    context 'when provided object is nil' do
       subject { helper.presenter_for(nil) }
       specify { expect(subject).to be_nil }
     end
 
-    context "when used with a block" do
+    context 'when used with a block' do
       specify { expect { |block| helper.presenter_for(Dummy.new, &block) }.to yield_control }
       specify { expect { |block| helper.presenter_for(Dummy.new, &block) }.to yield_with_args(instance_of(DummyPresenter)) }
-      specify { expect { |block|
-        helper.presenter_for(Dummy.new, Dummy2Presenter, &block)
-      }.to yield_with_args(instance_of(Dummy2Presenter)) }
+      specify do
+        expect do |block|
+          helper.presenter_for(Dummy.new, Dummy2Presenter, &block)
+        end.to yield_with_args(instance_of(Dummy2Presenter)) end
     end
 
-    context "when presenter does not exist" do
+    context 'when presenter does not exist' do
       subject { helper.presenter_for(UnknownKlass) }
       specify { expect { subject }.to raise_error(NameError) }
     end
@@ -37,36 +38,36 @@ RSpec.describe Tuxedo::ActionView::Helpers do
   describe 'prac' do
     subject { helper.prac Dummy.new, :name }
 
-    it "delegates to presenter_for" do
+    it 'delegates to presenter_for' do
       expect(helper).to receive(:presenter_for).with(instance_of(Dummy)).and_call_original
       subject
     end
 
-    context "providing a valid method name" do
-      it "calls the method on the presenter" do
+    context 'providing a valid method name' do
+      it 'calls the method on the presenter' do
         expect_any_instance_of(DummyPresenter).to receive(:name)
         subject
       end
 
-      context "with extra arguments" do
+      context 'with extra arguments' do
         subject { helper.prac Dummy.new, :name_with_args, 'Jan', surname: 'Stevens' }
-        it "calls the method with arguments on the presenter" do
+        it 'calls the method with arguments on the presenter' do
           expect_any_instance_of(DummyPresenter).to receive(:name_with_args).with('Jan', surname: 'Stevens')
           subject
         end
       end
     end
 
-    context "when the object is nil" do
+    context 'when the object is nil' do
       subject { helper.prac nil, :name }
-      it "should return nil" do
+      it 'should return nil' do
         expect(subject).to be_nil
       end
     end
 
-    context "when the method is nil" do
+    context 'when the method is nil' do
       subject { helper.prac Dummy.new, nil }
-      it "should return nil" do
+      it 'should return nil' do
         expect(subject).to be_nil
       end
     end

data/spec/spec_helper.rb

@@ -1,11 +1,26 @@
-require 'bundler/setup'
+require 'support/coverage'
 require 'tuxedo'
 require 'support/dummy_classes'
 
 RSpec.configure do |config|
-  config.expect_with(:rspec) { |c| c.syntax = :expect }
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
   config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with(:rspec) do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax = :expect
+  end
+
   config.mock_with :rspec do |mocks|
     mocks.yield_receiver_to_any_instance_implementation_blocks = true
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
   end
 end

data/spec/support/coverage.rb

@@ -0,0 +1,13 @@
+if ENV['TRAVIS'] || ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.add_filter '/spec/'
+
+  if ENV['TRAVIS']
+    require 'codeclimate-test-reporter'
+    CodeClimate::TestReporter.start
+  else
+    SimpleCov.start
+  end
+
+  SimpleCov.command_name "rspec_#{Process.pid}"
+end

data/spec/support/dummy_classes.rb

@@ -1,4 +1,7 @@
 class Dummy
+  def to_param
+    2
+  end
 end
 
 class DummyPresenter
@@ -22,5 +25,4 @@ class ApplicationPresenter
 end
 
 class OverwriteNamePresenter < ApplicationPresenter
-
 end

data/tuxedo_decorate.gemspec

@@ -4,34 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tuxedo/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "tuxedo_decorate"
+  gem.name          = 'tuxedo_decorate'
   gem.version       = Tuxedo::VERSION
-  gem.authors       = ["Jan Stevens"]
-  gem.email         = ["jan@playpass.be"]
+  gem.authors       = ['Jan Stevens', 'Maarten Claes']
+  gem.email         = ['jan@playpass.be', 'mcls@playpass.be']
 
-  gem.summary       = %q{Tuxedo simple presenter logic under 150 LOC}
-  gem.homepage      = "https://github.com/playpasshq/tuxedo"
-  gem.license       = "MIT"
+  gem.summary       = 'Tuxedo simple presenter logic under 150 LOC'
+  gem.homepage      = 'https://github.com/playpasshq/tuxedo'
+  gem.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if gem.respond_to?(:metadata)
-    gem.metadata['allowed_push_host'] = "https://rubygems.org"
+    gem.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
   gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|gem|features)/}) }
   gem.test_files    = gem.files.grep(%r{^(test|gem|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_development_dependency "bundler", "~> 1.3"
-  gem.add_development_dependency "rake", "~> 10.0"
-  gem.add_development_dependency "appraisal"
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "yard"
+  gem.require_paths = ['lib']
 
   gem.add_dependency 'activesupport', '>= 4.0.0'
   gem.add_dependency 'railties', '>= 4.0.0'
-  gem.add_dependency 'charlatan', '~> 0'
+  gem.add_dependency 'charlatan', '~> 0.1.0'
 end

metadata

@@ -1,85 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: tuxedo_decorate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jan Stevens
+- Maarten Claes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2015-12-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: 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: appraisal
-  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: rspec
-  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: yard
-  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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -114,25 +45,29 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 description: 
 email:
 - jan@playpass.be
+- mcls@playpass.be
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -140,6 +75,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
 - gemfiles/rails_4.2.gemfile
 - gemfiles/rails_stable.gemfile
 - lib/tuxedo.rb
@@ -150,6 +87,7 @@ files:
 - spec/config_spec.rb
 - spec/helpers/helpers_spec.rb
 - spec/spec_helper.rb
+- spec/support/coverage.rb
 - spec/support/dummy_classes.rb
 - spec/tuxedo_spec.rb
 - tuxedo_decorate.gemspec