minimalizer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3cd12461b740324f36bb3072f0eeb571bd365622
+  data.tar.gz: 41f079b1df0c15dcdb95df53e3152ae68d504233
+SHA512:
+  metadata.gz: 971c722baef967057363bee256938a458924e83fa36e6fcf3774e8ae291feb2f8f5222585c15580b89a807908ac4626ad70469c021fc3a89fdd085a0d437e7e8
+  data.tar.gz: 6e877f226ad28106c14295a8d98a6dc828c88ecf11b8d7ad6c36011c61b6957e95fb1a482e15a650b522ddd07dfd02abd5672b31b28a77b58719590924c98a60

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Theodore Kimble
+
+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,46 @@
+# Write Ruby on Rails applications more easily with Minimalizer
+
+Minimalizer is a lightweight Ruby on Rails engine that enables you to write more
+minimal Ruby on Rails applications. Minimalizer convenience methods help you
+write simpler model and controller tests and declare basic controller behaviors
+with ease.
+
+## Model Test Helpers
+
+Added to `ActiveSupport::TestCase`:
+
+* `assert_errors`
+* `refute_errors`
+* `validation_context`
+
+See `lib/minimalizer/model_test_helpers.rb` for more detailed documentation.
+
+## Controller Test Helpers
+
+Added to `ActionController::TestCase`:
+
+* `assert_redirect`
+* `assert_render`
+* `assert_flash`
+
+See `lib/minimalizer/controller_test_helpers.rb` for more detailed
+documentation.
+
+## Controller Helpers
+
+Added to `ActionController::Base`:
+
+* `self.new_actions`
+* `self.member_actions`
+* `create_resource`
+* `update_resource`
+* `destroy_resource`
+* `reorder_resources`
+* `toggle_resource_boolean_on`
+* `toggle_resource_boolean_off`
+
+See `lib/minimalizer/controller_helpers.rb` for more detailed documentation.
+
+## License
+
+Minimalizer is released under the MIT license. Copyright 2015 Theodore Kimble.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = Dir.glob('test/**/*_test.rb')
+end
+
+task(default: :test)

data/lib/minimalizer.rb

@@ -0,0 +1,6 @@
+require 'rails'
+require 'minimalizer/controller_helpers'
+require 'minimalizer/controller_test_helpers'
+require 'minimalizer/model_test_helpers'
+require 'minimalizer/engine'
+require 'minimalizer/version'

data/lib/minimalizer/controller_helpers.rb

@@ -0,0 +1,354 @@
+require 'action_controller'
+require 'active_support/concern'
+
+module Minimalizer
+  module ControllerHelpers
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Convenience method for specifying/excluding new actions in a before
+      # filter.
+      #
+      #   before_action only: new_actions do
+      #     @record = Record.new
+      #   end
+      def new_actions
+        %i[new create]
+      end
+
+      # Convenience method for specifying/excluding member actions in a before
+      # filter.
+      #
+      #   before_action only: member_actions do
+      #     @record = Record.find(params[:id])
+      #   end
+      def member_actions
+        %i[show edit update delete destroy]
+      end
+    end
+
+    # Create a new resource with the given attributes. If successful, set the
+    # ".notice" flash and redirect to the newly created resource; otherwise,
+    # set the ".alert" flash and render the new template with a 422 HTTP status
+    # reponse.
+    #
+    #   def create
+    #     create_resource @record, record_params
+    #   end
+    #
+    # A resource array can be provided to affect the redirect location. Only
+    # the last resource will be saved.
+    #
+    #   def create
+    #     create_resource [@parent, @record], record_params
+    #   end
+    #
+    # An optional :location argument will override the redirect location.
+    #
+    #   def create
+    #     create_resource @record, record_params, location: :records
+    #   end
+    #
+    # Passing a block will yield true if the model saves successfully, false
+    # otherwise.
+    #
+    #   def create
+    #     create_resource @record, record_params do |success|
+    #       if sucess
+    #         # something
+    #       else
+    #         # something
+    #       end
+    #     end
+    #   end
+    def create_resource(resource, attributes, location: nil)
+      model = resource.is_a?(Array) ? resource.last : resource
+      model.assign_attributes attributes
+
+      if model.save
+        flash.notice = t('.notice')
+        yield true if block_given?
+        redirect_to location || resource
+      else
+        flash.now.alert = t('.alert')
+        response.status = 422
+        yield false if block_given?
+        render :new
+      end
+    end
+
+
+    # Update an existing resource with the given attributes. If successful,
+    # set the ".notice" flash and redirect to the resource; otherwise, set the
+    # ".alert" flash and render the edit template with a 422 HTTP status
+    # response.
+    #
+    #   def update
+    #     update_resource @record, record_params
+    #   end
+    #
+    # A resource array can be provided to affect the redirect location. Only
+    # the last resource will be updated.
+    #
+    #   def update
+    #     update_resource [@parent, @record], record_params
+    #   end
+    #
+    # An optional :location argument will override the redirect location.
+    #
+    #   def update
+    #     update_resource @record, record_params, location: :records
+    #   end
+    #
+    # Passing a block will yield true if the model updates successfully, false
+    # otherwise.
+    #
+    #   def update
+    #     update_resource @record, record_params do |success|
+    #       if sucess
+    #         # something
+    #       else
+    #         # something
+    #       end
+    #     end
+    #   end
+    def update_resource(resource, attributes, location: nil)
+      model = resource.is_a?(Array) ? resource.last : resource
+
+      if model.update(attributes)
+        flash.notice = t('.notice')
+        yield true if block_given?
+        redirect_to location || resource
+      else
+        flash.now.alert = t('.alert')
+        response.status = 422
+        yield false if block_given?
+        render :edit
+      end
+    end
+
+    # Delete the given model.
+    #
+    # If the operation succeeds, provide a successful flash notice and
+    # redirect to the provided location (if given) or to the pluralized path
+    # of the original resource.
+    #
+    # If the operation fails, provide a failed flash alert. Then, if the
+    # :delete action exists, render the edit action with an
+    # :unprocessable_entity HTTP status; if the action does not exist,
+    # redirect to the original resource.
+    #
+    #
+    #
+    # Destroy an existing resource. If successful, set the ".notice" flash and
+    # redirect to the symbolized, plural name of the resource; otherwise, set
+    # the ".alert" flash and render the delete template with a 422 HTTP status
+    # response; if the delete action is not defined, instead redirect the
+    # resource.
+    #
+    #   def destroy
+    #     destroy_resource @record
+    #   end
+    #
+    # A resource array can be provided to affect the redirect location. Only
+    # the last resource will be destroyed.
+    #
+    #   def destroy
+    #     destroy_resource [@parent, @record]
+    #   end
+    #
+    # An optional :location argument will override the redirect location.
+    #
+    #   def destroy
+    #     destroy_resource @record, location: :root
+    #   end
+    #
+    # Passing a block will yield true if the model destroys successfully, false
+    # otherwise.
+    #
+    #   def destroy
+    #     destroy_resource @record do |success|
+    #       if sucess
+    #         # something
+    #       else
+    #         # something
+    #       end
+    #     end
+    #   end
+    def destroy_resource(resource, location: nil)
+      model = resource.is_a?(Array) ? resource.last : resource
+
+      if model.destroy
+        if !location
+          location = Array(resource)[0..-2] + [model.model_name.plural.to_sym]
+        end
+
+        flash.notice = t('.notice')
+        yield true if block_given?
+        redirect_to location
+      else
+        if respond_to?(:delete)
+          flash.now.alert = t('.alert')
+          response.status = 422
+          yield false if block_given?
+          render :delete
+        else
+          flash.alert = t('.alert')
+          yield false if block_given?
+          redirect_to resource
+        end
+      end
+    end
+
+    # Reorder the given models on the order attribute by the given attributes.
+    #
+    # If all operations succeed, provide a successful flash notice and
+    # redirect to the provided location (if given) or to the pluralized path
+    # of the first original resource.
+    #
+    # If any operation fails, provide a failed flash alert and render the
+    # :edit action with an :unprocessable_entity HTTP status.
+    #
+    #   def update
+    #     reorder_resources @records, record_params
+    #   end
+    #
+    # An optional :attribute argument will override the default reording
+    # attribute (:position).
+    #
+    #   def update
+    #     reorder_resources @records, record_params, attribute: :ranking
+    #   end
+    #
+    # An optional :location argument will override the redirect location.
+    #
+    #   def update
+    #     reorder_resources @records, record_params, location: :root
+    #   end
+    #
+    # Passing a block will yield true if all models are reordered successfully,
+    # false otherwise.
+    #
+    #   def update
+    #     reorder_resources @records, record_params do |success|
+    #       if sucess
+    #         # something
+    #       else
+    #         # something
+    #       end
+    #     end
+    #   end
+    def reorder_resources(resources, attributes, attribute: :position, location: nil)
+      models = resources.is_a?(Array) && (resources.last.is_a?(Array) || resources.last.is_a?(ActiveRecord::Relation)) ? resources.last : resources
+
+      models.each do |model|
+        model.update(attribute => attributes[model.id.to_s].to_i)
+      end
+
+      if models.all? { |model| model.errors.empty? }
+        if !location
+          if models.any?
+            location = Array(resources)[0..-2] + [models.first.model_name.plural.to_sym]
+          else
+            raise ArgumentError, 'Must provide one or more resources or the :location argument'
+          end
+        end
+
+        flash.notice = t('.notice')
+        yield true if block_given?
+        redirect_to location
+      else
+        flash.now.alert = t('.alert')
+        response.status = 422
+        yield false if block_given?
+        render :edit
+      end
+    end
+
+    # Toggle the given model attribute on.
+    #
+    # If the operation succeeds, provide a successful flash notice; otherwise,
+    # provide a failed flash alert. Redirect to the provided location (if
+    # given) or to the initial resource.
+    #
+    #   def update
+    #     toggle_resource_boolen_on @record, :active
+    #   end
+    #
+    # An optional :location argument will override the redirect location.
+    #
+    #   def update
+    #     toggle_resource_boolen_on @record, :active, location: :records
+    #   end
+    #
+    # Passing a block will yield true if the model is updated successfully,
+    # false otherwise.
+    #
+    #   def update
+    #     toggle_resource_boolen_on @record, :active do |success|
+    #       if success
+    #         # something
+    #       else
+    #         # something
+    #       end
+    #     end
+    #   end
+    def toggle_resource_boolean_on(resource, attribute, location: nil)
+      model = resource.is_a?(Array) ? resource.last : resource
+
+      if model.update(attribute => true)
+        flash.notice = t('.notice')
+        yield true if block_given?
+        redirect_to location || resource
+      else
+        flash.alert = t('.alert')
+        yield false if block_given?
+        redirect_to location || resource
+      end
+    end
+
+    # Toggle the given model attribute off.
+    #
+    # If the operation succeeds, provide a successful flash notice; otherwise,
+    # provide a failed flash alert. Redirect to the provided location (if
+    # given) or to the initial resource.
+    #
+    #   def update
+    #     toggle_resource_boolen_off @record, :active
+    #   end
+    #
+    # An optional :location argument will override the redirect location.
+    #
+    #   def update
+    #     toggle_resource_boolen_off @record, :active, location: :records
+    #   end
+    #
+    # Passing a block will yield true if the model is updated successfully,
+    # false otherwise.
+    #
+    #   def update
+    #     toggle_resource_boolen_off @record, :active do |success|
+    #       if success
+    #         # something
+    #       else
+    #         # something
+    #       end
+    #     end
+    #   end
+    def toggle_resource_boolean_off(resource, attribute, location: nil)
+      model = resource.is_a?(Array) ? resource.last : resource
+
+      if model.update(attribute => false)
+        flash.notice = t('.notice')
+        yield true if block_given?
+        redirect_to location || resource
+      else
+        flash.alert = t('.alert')
+        yield false if block_given?
+        redirect_to location || resource
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, Minimalizer::ControllerHelpers

data/lib/minimalizer/controller_test_helpers.rb

@@ -0,0 +1,41 @@
+require 'action_controller'
+require 'active_support/concern'
+
+module Minimalizer
+  module ControllerTestHelpers
+    extend ActiveSupport::Concern
+
+    private
+
+    # Assert the correct redirect location is given; optionally test the
+    # response status and flash messages.
+    def assert_redirect(location, status: 302, alert: nil, notice: nil)
+      assert_redirected_to location
+      assert_response status
+      assert_flash :alert, alert if alert
+      assert_flash :notice, notice if notice
+    end
+
+    # Assert the correct template is rendered; optionally test the response
+    # status and flash messages.
+    def assert_render(template, status: 200, alert: nil, notice: nil)
+      assert_template template
+      assert_response status
+      assert_flash :alert, alert if alert
+      assert_flash :notice, notice if notice
+    end
+
+    # Assert that the flash variant (e.g. :notice) is equal to the local
+    # translation for the given key.
+    def assert_flash(variant, key)
+      assert_equal I18n.t(key, scope: local_translation_scope), flash[variant]
+    end
+
+    # Local translation scope for the current controller and action.
+    def local_translation_scope
+      [@controller.controller_path.split('/'), @controller.action_name].flatten.compact.join('.')
+    end
+  end
+end
+
+ActionController::TestCase.send :include, Minimalizer::ControllerTestHelpers

data/lib/minimalizer/engine.rb

@@ -0,0 +1,12 @@
+module Minimalizer
+  class Engine < ::Rails::Engine
+    initializer 'minimalizer.add_controller_helpers' do
+    end
+
+    initializer 'minimalizer.add_controller_test_helpers' do
+    end
+
+    initializer 'minimalizer.add_model_test_helpers' do
+    end
+  end
+end

data/lib/minimalizer/model_test_helpers.rb

@@ -0,0 +1,47 @@
+require 'active_model'
+require 'active_model/errors_details'
+require 'active_support/concern'
+
+module Minimalizer
+  module ModelTestHelpers
+    extend ActiveSupport::Concern
+
+    private
+
+    # Assert that the given model‘s attribute contains errors. If error details
+    # are provided, assert that each provided set of details is found on the
+    # model’s attribute.
+    def assert_errors(attribute, model, *error_details)
+      model.valid?(@_validation_context)
+      assert_not_empty model.errors[attribute]
+
+      if error_details.any?
+        model_error_details = model.errors.details[attribute]
+        model_errors = model_error_details.map { |d| d[:error] }
+
+        error_details.each do |details|
+          if details.keys == [:error]
+            assert_includes model_errors, details[:error], "Expected error details to include error #{details[:error]}; found #{model_errors}."
+          else
+            assert_includes model_error_details, details, "Expected error details to include #{details}: Found #{model_error_details}."
+          end
+        end
+      end
+    end
+
+    # Refute that the given model‘s attribute contains any errors.
+    def refute_errors(attribute, model)
+      model.valid?(@_validation_context)
+      assert_empty model.errors[attribute]
+    end
+
+    # Set the validation context used during model error assertions.
+    def validation_context(context)
+      @_validation_context = context
+      yield
+      @_validation_context = nil
+    end
+  end
+end
+
+ActiveSupport::TestCase.send :include, Minimalizer::ModelTestHelpers

data/lib/minimalizer/version.rb

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

data/test/minimalizer/controller_helpers_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class Minimalizer::ControllerHelpersTest < Minitest::Test
+  def test_new_actions
+    assert_equal %i[new create], ActionController::Base.new_actions
+  end
+
+  def test_member_actions
+    assert_equal %i[show edit update delete destroy], ActionController::Base.member_actions
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rack/test'
+require 'minimalizer'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+ActiveSupport::TestCase.test_order = :random

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: minimalizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Theodore Kimble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: rails
+  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: active_model-errors_details
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: |2
+      Minimalizer is a lightweight Ruby on Rails engine that enables you to write
+      more minimal Ruby on Rails applications. Minimalizer convenience methods
+      help you write simpler model and controller tests and declare basic
+      controller behaviors with ease.
+email:
+- mail@theodorekimble.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/minimalizer.rb
+- lib/minimalizer/controller_helpers.rb
+- lib/minimalizer/controller_test_helpers.rb
+- lib/minimalizer/engine.rb
+- lib/minimalizer/model_test_helpers.rb
+- lib/minimalizer/version.rb
+- test/minimalizer/controller_helpers_test.rb
+- test/test_helper.rb
+homepage: https://github.com/theodorekimble/minimalizer
+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.5
+signing_key: 
+specification_version: 4
+summary: Write Ruby on Rails applications more easily with Minimalizer
+test_files:
+- test/minimalizer/controller_helpers_test.rb
+- test/test_helper.rb