simple_exposure 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d56dca6e52b4aca0a6e0997d31b63a947a8be86
+  data.tar.gz: d702aab2f42718b45b9d66f2fe6cdbcfabdb7f96
+SHA512:
+  metadata.gz: ce2a6f63cc872a0279129c09bd632b006c9440568da9ef0feacf2c53e778e0de977e2a947c9b9d4ce9b5356907002818656ca68ee8f437f12274e5802fe20685
+  data.tar.gz: 4190b607787e3c58ea15db46baa2ed31e0075efb221f85d29295174a5aec7cd9176466f681b8fba2cb645714be578197a81390e524a5d1bd435cfde51012ea9e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+simple-exposure

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michal Krejčí
+
+MIT License
+
+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,167 @@
+# SimpleExposure
+
+Simplify sharing state between Rails controllers and views and reduce noise in Rails controllers for those who are tired of writing the same code over and over again.
+
+Based on the idea behind [view_accessor](https://github.com/invisiblefunnel/view_accessor) borrowing features I like from [decent_exposure](https://github.com/voxdolo/decent_exposure).
+
+## Basic example
+
+```ruby
+# controllers/projects_controller.rb
+class ProjectsController < ApplicationController
+  expose(:projects) { Project.all }
+end
+
+# views/projects/index.html.slim
+- projects.each do |project|
+  p = project.title
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_exposure'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_exposure
+
+## Usage
+
+### Share controller's state to the views:
+
+```ruby
+# controllers/projects_controller.rb
+class ProjectsController < ApplicationController
+  expose :projects
+
+  def index
+    self.projects = Project.all
+  end
+end
+
+# views/projects/index.html.slim
+- projects.each do |project|
+  p = project.title
+```
+
+### Provide default values
+
+```ruby
+class ProjectsController < ApplicationController
+  expose(:projects) { Project.all }
+end
+```
+
+### Remove common noise with extensions
+
+Before:
+
+```ruby
+class ProjectsController < ApplicationController
+
+  def index
+    @projects = Project.page(params[:page])
+  end
+
+end
+```
+
+After:
+
+```ruby
+class ProjectsController < ApplicationController
+  expose :projects, extend: :paginate
+
+  def index
+    self.projects = Project.all
+  end
+end
+```
+
+### Combine multiple extensions
+
+```ruby
+class ProjectsController < ApplicationController
+  expose :projects, extend: %i(paginate decorate)
+
+  def index
+    self.projects = Project.all
+  end
+end
+```
+
+### Combine it all together for a greater good
+
+Before:
+
+```ruby
+class ProjectsController < ApplicationController
+
+  def index
+    @projects = current_user.projects.ordered
+    @completed_projects = @projects.completed.page(params[:page])
+    @current_user = current_user.decorate
+  end
+
+end
+```
+
+After:
+
+```ruby
+class ProjectsController < ApplicationController
+  expose :current_user, extend: :decorate
+
+  expose :projects do
+    current_user.projects.ordered
+  end
+
+  expose :completed_projects, extend: :paginate do
+    projects.completed
+  end
+end
+```
+
+## Extensions
+
+### Built-in extensions
+
+Library provides two built-in extensions:
+
++ paginate (Kaminari)
++ decorate (Draper)
+
+### Writing your own extensions
+
+```ruby
+module SimpleExposure
+  module Extensions
+    module MyExtension
+      extend self
+
+      def apply(value, controller)
+        # Do something with the value here
+      end
+    end
+  end
+end
+
+class ProjectsController < ApplicationController
+  expose :projects, extend: :my_extension
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple_exposure.rb

@@ -0,0 +1,8 @@
+require 'simple_exposure/version'
+require 'simple_exposure/before_render'
+require 'simple_exposure/core'
+
+ActiveSupport.on_load(:action_controller) do
+  include SimpleExposure::BeforeRender
+  include SimpleExposure::Core
+end

data/lib/simple_exposure/before_render.rb

@@ -0,0 +1,42 @@
+require 'active_support/concern'
+
+module SimpleExposure
+  module BeforeRender
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :render, :before_render_action
+      define_callbacks :render
+    end
+
+    def render_with_before_render_action(*options, &block)
+      run_callbacks :render do
+        render_without_before_render_action(*options, &block)
+      end
+    end
+
+    module ClassMethods
+      def append_before_render_action(*names, &block)
+        _insert_callbacks(names, block) do |name, options|
+          set_callback :render, :before, name, options
+        end
+      end
+
+      def prepend_before_render_action(*names, &block)
+        _insert_callbacks(names, block) do |name, options|
+          set_callback :render, :before, name, options.merge(prepend: true)
+        end
+      end
+
+      def skip_before_render_action(*names, &block)
+        _insert_callbacks(names, block) do |name, options|
+          skip_callback :render, :before, name, options
+        end
+      end
+
+      alias_method :before_render, :append_before_render_action
+      alias_method :prepend_before_render, :prepend_before_render_action
+      alias_method :skip_before_render, :skip_before_render_action
+    end
+  end
+end

data/lib/simple_exposure/core.rb

@@ -0,0 +1,94 @@
+require 'simple_exposure/extensions/paginate'
+require 'simple_exposure/extensions/decorate'
+
+module SimpleExposure
+  module Core
+    extend ActiveSupport::Concern
+
+    UnknownExtension = Class.new(NameError)
+
+    included do
+      delegate :_exposure_extensions, 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)
+        end
+      end
+    end
+
+    def _apply_exposure_extension(attribute, extension)
+      value = send(attribute)
+      extension = _exposure_extension_class(extension)
+      send :"#{attribute}=", extension.apply(value, self)
+    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)
+        options = attributes.extract_options!
+
+        extensions = options.fetch(:extend, nil)
+        extensions = Array(extensions)
+
+        _define_exposure_accessors(attributes, &block)
+        _define_exposure_extensions(attributes, extensions)
+      end
+
+      def _exposure_extensions
+        @_exposure_extensions ||= HashWithIndifferentAccess.new([])
+      end
+
+      private
+
+      def _define_exposure_accessors(attributes, &block)
+        _define_exposure_readers(attributes, &block)
+        _define_exposure_writers(attributes)
+      end
+
+      def _define_exposure_readers(attributes, &block)
+        attributes.each do |attribute|
+          _define_exposure_reader(attribute, &block)
+        end
+      end
+
+      def _define_exposure_reader(attribute, &block)
+        if block
+          _define_exposure_reader_with_defaults(attribute, &block)
+        else
+          attr_reader(attribute)
+        end
+
+        helper_method(attribute)
+        hide_action(attribute)
+      end
+
+      def _define_exposure_reader_with_defaults(attribute, &block)
+        define_method(attribute) do
+          value = instance_variable_get("@#{attribute}")
+          return value if value
+          send :"#{attribute}=", instance_eval(&block)
+        end
+      end
+
+      def _define_exposure_writers(attributes)
+        attr_writer(*attributes)
+      end
+
+      def _define_exposure_extensions(attributes, extensions)
+        attributes.each do |attribute|
+          _exposure_extensions[attribute] += extensions
+        end
+      end
+    end
+  end
+end

data/lib/simple_exposure/extensions/decorate.rb

@@ -0,0 +1,11 @@
+module SimpleExposure
+  module Extensions
+    module Decorate
+      extend self
+
+      def apply(value, _)
+        value.decorate
+      end
+    end
+  end
+end

data/lib/simple_exposure/extensions/paginate.rb

@@ -0,0 +1,11 @@
+module SimpleExposure
+  module Extensions
+    module Paginate
+      extend self
+
+      def apply(value, controller)
+        value.page controller.params[:page]
+      end
+    end
+  end
+end

data/lib/simple_exposure/version.rb

@@ -0,0 +1,3 @@
+module SimpleExposure
+  VERSION = '0.0.1'
+end

data/simple_exposure.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_exposure/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_exposure'
+  spec.version       = SimpleExposure::VERSION
+  spec.authors       = ['Michal Krejčí']
+  spec.email         = ['work@mikekreeki.com']
+  spec.description   = 'Cleanup your Rails controllers'
+  spec.summary       = 'Cleanup your Rails controllers'
+  spec.homepage      = 'https://github.com/mikekreeki/simple_exposure'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  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/dummy/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp