simple_exposure 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6213f9983cd1304fe8a1ca1b5b07439dde3f44d
-  data.tar.gz: f51988204546151b272a6332ba049f4046901f1d
+  metadata.gz: c4ac6213c3f38471d413641334b633e9f930c36a
+  data.tar.gz: cffbf6e5672dbf1ec8feebb49ecd3f0e5396441b
 SHA512:
-  metadata.gz: c1f5e71198dcd3cf61165a39baabd819069db2ce2e790cf25244b26ed76c82058ddb375d9cc64f964d14a40e0050bbc214f4fb18e00a4d27d0c013021b454870
-  data.tar.gz: 9b6827ad0f3cb77ba298e115e8b0dee0163d1155951b84dea155ca27de33f10491453cea18e46bff1bdc4a95ea2b11be88d0a6cdd2261b6f8bad56feac4689bd
+  metadata.gz: 28f0a6fbac384b2adc6ed468e9c82ae0835c86ab8c3107093364166c93d43811c5329d6489aa2c752bd5da224ccd85d5afc8be6a36a98a91b44a34f6af5b54ad
+  data.tar.gz: 73217785155e4003aa33ebe131b90d1807341d320624dec4ef9efc1c612a5a5f74f9ab1f625196b53062bfce3f398d05f0016f6969d0af4e3cd2b50dcf46cad5

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## v0.1.0
+
++ Added extension shortcuts (e.g. `paginate :users`)
++ Moved UnknownExtension exception directly to SimpleExposure namespace (SimpleExposure::UnknownExtension)
+
+## v0.0.2
+
++ Don't apply extensions when no value is provided
+
+## v0.0.1
+
++ Initial impementation

data/README.md

@@ -1,6 +1,6 @@
 # SimpleExposure
 
-![Gem version](http://img.shields.io/gem/v/simple_exposure.svg) 
+![Gem version](http://img.shields.io/gem/v/simple_exposure.svg)
 ![Code Climate](http://img.shields.io/codeclimate/github/mikekreeki/simple_exposure.svg)
 ![Travis CI](http://img.shields.io/travis/mikekreeki/simple_exposure.svg)
 ![Github Issues](http://img.shields.io/github/issues/mikekreeki/simple_exposure.svg)
@@ -22,6 +22,8 @@ end
   p = project.title
 ```
 
+Wait, there's  more!
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -43,11 +45,15 @@ Or install it yourself as:
 ```ruby
 # controllers/projects_controller.rb
 class ProjectsController < ApplicationController
-  expose :projects
+  expose :projects, :project
 
   def index
     self.projects = Project.all
   end
+
+  def show
+    self.project = Project.find(1)
+  end
 end
 
 # views/projects/index.html.slim
@@ -55,6 +61,21 @@ end
   p = project.title
 ```
 
+Expose controller methods to the views:
+
+```ruby
+# controllers/projects_controller.rb
+class ProjectsController < ApplicationController
+  expose :project
+
+  private
+
+  def project
+    @project ||= Project.find(1)
+  end
+end
+```
+
 ### Provide default values
 
 ```ruby
@@ -73,12 +94,23 @@ class ProjectsController < ApplicationController
   def index
     @projects = Project.page(params[:page])
   end
-
 end
 ```
 
 After:
 
+```ruby
+class ProjectsController < ApplicationController
+  paginate :projects
+
+  def index
+    self.projects = Project.all
+  end
+end
+```
+
+Which is the same as:
+
 ```ruby
 class ProjectsController < ApplicationController
   expose :projects, extend: :paginate
@@ -91,6 +123,31 @@ end
 
 ### Combine multiple extensions
 
+Before:
+
+```ruby
+class ProjectsController < ApplicationController
+
+  def index
+    @projects = Project.page(params[:page]).decorate
+  end
+end
+```
+
+After:
+
+```ruby
+class ProjectsController < ApplicationController
+  paginate :projects, extend: :decorate
+
+  def index
+    self.projects = Project.all
+  end
+end
+```
+
+Which is the same as:
+
 ```ruby
 class ProjectsController < ApplicationController
   expose :projects, extend: %i(paginate decorate)
@@ -121,15 +178,13 @@ After:
 
 ```ruby
 class ProjectsController < ApplicationController
-  expose :current_user, extend: :decorate
+  decorate :current_user
 
   expose :projects do
     current_user.projects.ordered
   end
 
-  expose :completed_projects, extend: :paginate do
-    projects.completed
-  end
+  paginate(:completed_projects) { projects.completed }
 end
 ```
 
@@ -158,10 +213,19 @@ module SimpleExposure
 end
 
 class ProjectsController < ApplicationController
+  my_extension :projects
+  # or
   expose :projects, extend: :my_extension
 end
 ```
 
+Note that extensions are applied at the time of `render`, not immediately when the value is assigned.
+
+## Similar projects
+
++ [view_accessor](https://github.com/invisiblefunnel/view_accessor)
++ [obviews](https://github.com/elia/obviews)
++ [decent_exposure](https://github.com/voxdolo/decent_exposure)
 
 ## Contributing
 

data/lib/simple_exposure/core.rb

@@ -2,20 +2,21 @@ require 'simple_exposure/extensions/paginate'
 require 'simple_exposure/extensions/decorate'
 
 module SimpleExposure
+  UnknownExtension = Class.new(NameError)
+
   module Core
     extend ActiveSupport::Concern
 
-    UnknownExtension = Class.new(NameError)
-
     included do
       delegate :_exposure_extensions, to: :class
+      delegate :_exposure_extension_class, to: :class
       before_render :_apply_exposure_extensions
     end
 
     def _apply_exposure_extensions
       _exposure_extensions.each do |attribute, extensions|
         extensions.each do |extension|
-          _apply_exposure_extension(attribute, extension)
+          _apply_exposure_extension(attribute, extension.to_s)
         end
       end
     end
@@ -29,12 +30,6 @@ module SimpleExposure
       end
     end
 
-    def _exposure_extension_class(extension)
-      Extensions.const_get(extension.camelize)
-    rescue NameError
-      raise UnknownExtension, "Unknown extension: #{extension}"
-    end
-
     module ClassMethods
 
       def expose(*attributes, &block)
@@ -51,6 +46,12 @@ module SimpleExposure
         @_exposure_extensions ||= HashWithIndifferentAccess.new([])
       end
 
+      def _exposure_extension_class(extension)
+        Extensions.const_get(extension.camelize)
+      rescue NameError
+        raise UnknownExtension, "Unknown extension: #{extension}"
+      end
+
       private
 
       def _define_exposure_accessors(attributes, &block)
@@ -92,6 +93,29 @@ module SimpleExposure
           _exposure_extensions[attribute] += extensions
         end
       end
+
+      def method_missing(extension, *attributes, &block)
+        extension_class = _exposure_extension_class(extension.to_s)
+        if extension_class
+          options = attributes.extract_options!
+
+          extensions = options.fetch(:extend, nil)
+          extensions = Array(extensions)
+          extensions = extensions.prepend(extension)
+
+          options = options.merge(extend: extensions)
+
+          expose(*attributes, options, &block)
+        end
+      rescue UnknownExtension
+        super
+      end
+
+      def respond_to_missing?(extension, include_private = false)
+        _exposure_extension_class(extension.to_s)
+      rescue UnknownExtension
+        false
+      end
     end
   end
 end

data/lib/simple_exposure/version.rb

@@ -1,3 +1,3 @@
 module SimpleExposure
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/simple_exposure.gemspec

@@ -20,5 +20,4 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'rails', ['>= 3.2.3', '< 5']
   spec.add_development_dependency 'rspec-rails', '~> 3.0.0'
-  spec.add_development_dependency 'capybara'
 end

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe ApplicationController, type: :controller do
+  let(:view) { controller.view_context }
+
+  it 'loads the modules' do
+    expect(described_class.ancestors).to include(SimpleExposure::Core)
+  end
+
+  it 'responds to #expose' do
+    expect(described_class).to respond_to(:expose)
+  end
+
+  before do
+    get :index
+  end
+
+  describe 'Inline definition of multiple exposed attributes' do
+    it 'exposes multiple attributes defined inline' do
+      expect(view.my_name).to eq 'Jane Doe'
+      expect(view.your_name).to eq 'Jane Doe'
+    end
+  end
+
+  describe 'Default values' do
+    it 'assigns default value' do
+      expect(view.message).to eq 'Hello!'
+    end
+
+    it 'does not override provided values with default one' do
+      expect(view.other_message).to eq 'Other message'
+    end
+  end
+
+  describe 'Exposing controllers instance variables' do
+    it 'exposes the value in ivar' do
+      expect(view.ivar_message).to eq 'Hello!'
+    end
+  end
+
+  describe 'Exposing private methods' do
+    it 'exposes controllers private methods' do
+      expect(view.current_user).to eq 'mikekreeki'
+    end
+  end
+
+  describe 'Extensions' do
+    it 'applies extension when value provided' do
+      expect(view.decoratable_message).to eq 'Hello!'
+    end
+
+    it 'does not apply extension when value not provided' do
+      expect(view.nil_value).to be_nil
+    end
+  end
+
+  describe 'Extension shortcuts' do
+    it 'quacks like a shortcut' do
+      expect(described_class).to respond_to :decorate
+    end
+
+    it 'applies the extension when specified using a shortcut' do
+      expect(view.second_user).to eq 'Andrew Bennett'
+      expect(view.third_user).to eq 'Andrew Bennett'
+    end
+
+    it 'takes additional extensions' do
+      expect(view.combined_extension).to eq 'HELLO'
+    end
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,18 +1,42 @@
+require 'ostruct'
+
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
 
-  expose(:message) { 'Hello!' }
+  expose(:my_name, :your_name) { 'Jane Doe' }
+
+  expose(:message)       { 'Hello!' }
+  expose(:other_message) { 'Hello!' }
+  expose(:ivar_message)
 
   expose(:current_user)
 
-  expose(:posts_count) { 0 }
+  expose(:decoratable_message, extend: :decorate) do
+    OpenStruct.new(decorate: 'Hello!')
+  end
 
   expose(:nil_value, extend: :decorate)
 
+  decorate(:second_user, :third_user) { OpenStruct.new(decorate: 'Andrew Bennett') }
+
+  paginate :combined_extension, extend: :decorate do
+    Class.new do
+      def page(*)
+        @name = 'Hello'
+        self
+      end
+
+      def decorate
+        @name.upcase
+      end
+    end.new
+  end
+
   def index
-    @posts_count = 2
+    self.other_message = 'Other message'
+    @ivar_message = 'Hello!'
   end
 
   private

data/spec/dummy/app/views/application/index.html.erb

@@ -1,7 +0,0 @@
-<%= message %>
-
-<%= current_user %>
-
-<%= posts_count %>
-
-<%= nil_value %>

data/spec/spec_helper.rb

@@ -2,12 +2,6 @@ ENV['RAILS_ENV'] ||= 'test'
 require File.expand_path('../dummy/config/environment', __FILE__)
 
 require 'rspec/rails'
-require 'capybara/rspec'
-
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories.
-Dir[Rails.root.join('spec/support/**/*.rb')].each {|f| require f}
 
 RSpec.configure do |config|
-  config.include Capybara::DSL, type: :integration
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_exposure
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Michal Krejčí
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,20 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: capybara
-  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: Cleanup your Rails controllers
 email:
 - work@mikekreeki.com
@@ -69,6 +55,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -80,6 +67,7 @@ files:
 - lib/simple_exposure/extensions/paginate.rb
 - lib/simple_exposure/version.rb
 - simple_exposure.gemspec
+- spec/controllers/application_controller_spec.rb
 - spec/dummy/.gitignore
 - spec/dummy/Gemfile
 - spec/dummy/README.rdoc
@@ -134,8 +122,6 @@ files:
 - spec/dummy/test/test_helper.rb
 - spec/dummy/vendor/assets/javascripts/.keep
 - spec/dummy/vendor/assets/stylesheets/.keep
-- spec/integration/simple_exposure_spec.rb
-- spec/simple_exposure/core_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mikekreeki/simple_exposure
 licenses:
@@ -162,6 +148,7 @@ signing_key:
 specification_version: 4
 summary: Cleanup your Rails controllers
 test_files:
+- spec/controllers/application_controller_spec.rb
 - spec/dummy/.gitignore
 - spec/dummy/Gemfile
 - spec/dummy/README.rdoc
@@ -216,6 +203,4 @@ test_files:
 - spec/dummy/test/test_helper.rb
 - spec/dummy/vendor/assets/javascripts/.keep
 - spec/dummy/vendor/assets/stylesheets/.keep
-- spec/integration/simple_exposure_spec.rb
-- spec/simple_exposure/core_spec.rb
 - spec/spec_helper.rb

data/spec/integration/simple_exposure_spec.rb

@@ -1,21 +0,0 @@
-require 'spec_helper'
-
-describe SimpleExposure, type: :integration do
-  it 'loads the modules' do
-    expect(ActionController::Base.ancestors).to include(SimpleExposure::Core)
-  end
-
-  let(:controller) { ApplicationController.new }
-
-  it 'can see the content' do
-    visit '/'
-
-    controller.index
-
-    expect(page).to have_content controller.send(:message)
-    expect(page).to have_content controller.send(:current_user)
-    expect(page).to have_content controller.send(:posts_count)
-  end
-
-
-end

data/spec/simple_exposure/core_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-
-describe SimpleExposure::Core do
-  let(:controller) { ApplicationController.new }
-
-  it 'responds to #expose' do
-    expect(controller.class).to respond_to(:expose)
-  end
-end