solidus_responders 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2efd3622b02ca6e57e36593071f2b856ff387e8b
+  data.tar.gz: 5e3bb4ee396eecbe4c0600a215eaa5749e81ce2b
+SHA512:
+  metadata.gz: bd13ad3fa5d62dd2060b962ab096f16a67cb4c625cbb6abe19f6e0ec7a5b422987b9f6d02bccf3dbbdc5a28fe8f9bfcee387b082f32c38f37f6d5d2f74c4f5c0
+  data.tar.gz: 6d28f740b8315fdb9e3d2a9e650525f882a925f1fa378000d26bf9aae21c2ea11ec35426b6e04dd9f49ca54a35b006f0d36eac0efdbcbd15a199d3e3b003197c

data/README.md

@@ -0,0 +1,32 @@
+Solidus Responders
+==============
+
+Solidus responders allows customizing and overriding responders within solidus.
+For more information about responders, see the responders gem:
+
+[plataformatec/responders](https://github.com/plataformatec/responders)
+
+Installation
+------------
+
+Add solidus_responders to your Gemfile:
+
+```ruby
+gem 'solidus_responders'
+```
+
+Bundle your dependencies:
+
+```shell
+bundle
+```
+
+Testing
+-------
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'spree/testing_support/extension_rake'
+  require 'rubocop/rake_task'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  RuboCop::RakeTask.new
+
+  task default: %i(first_run rubocop spec)
+rescue LoadError
+  # no rspec available
+end
+
+task :first_run do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_responders'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/controllers/spree/base_controller_decorator.rb

@@ -0,0 +1,9 @@
+module Spree
+  module RespondWith
+    def self.prepended(base)
+      base.include Spree::Core::ControllerHelpers::RespondWith
+    end
+  end
+end
+
+Spree::BaseController.prepend Spree::RespondWith

data/lib/solidus_responders.rb

@@ -0,0 +1,4 @@
+require 'solidus_core'
+require 'solidus_responders/engine'
+require 'solidus_responders/responder'
+require 'solidus_responders/controller_helpers/respond_with'

data/lib/solidus_responders/controller_helpers/respond_with.rb

@@ -0,0 +1,65 @@
+require 'solidus_responders/responder'
+
+module ActionController
+  class Base
+    def respond_with(*resources, &block)
+      if Spree::BaseController.spree_responders.keys.include?(self.class.to_s.to_sym)
+        # Checkout AS Array#extract_options! and original respond_with
+        # implementation for a better picture of this hack
+        if resources.last.is_a? Hash
+          resources.last[:action_name] = action_name.to_sym
+        else
+          resources.push action_name: action_name.to_sym
+        end
+      end
+
+      super
+    end
+  end
+end
+
+module Spree
+  module Core
+    module ControllerHelpers
+      module RespondWith
+        extend ActiveSupport::Concern
+
+        included do
+          cattr_accessor :spree_responders
+          self.spree_responders = {}
+          self.responder = Spree::Responder
+        end
+
+        module ClassMethods
+          def clear_overrides!
+            self.spree_responders = {}
+          end
+
+          def respond_override(options = {})
+            unless options.blank?
+              action_name = options.keys.first
+              action_value = options.values.first
+
+              if action_name.blank? || action_value.blank?
+                raise ArgumentError, "invalid values supplied #{options.inspect}"
+              end
+
+              format_name = action_value.keys.first
+              format_value = action_value.values.first
+
+              if format_name.blank? || format_value.blank?
+                raise ArgumentError, "invalid values supplied #{options.inspect}"
+              end
+
+              if format_value.is_a?(Proc)
+                options = { action_name.to_sym => { format_name.to_sym => { success: format_value } } }
+              end
+
+              spree_responders.deep_merge!(name.to_sym => options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solidus_responders/engine.rb

@@ -0,0 +1,20 @@
+module SolidusResponders
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_responders'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/solidus_responders/responder.rb

@@ -0,0 +1,44 @@
+module Spree
+  class Responder < ::ActionController::Responder #:nodoc:
+    attr_accessor :on_success, :on_failure
+
+    def initialize(controller, resources, options = {})
+      super
+
+      class_name = controller.class.name.to_sym
+      action_name = options.delete(:action_name)
+
+      if result = Spree::BaseController.spree_responders[class_name].try(:[], action_name).try(:[], format.to_sym)
+        self.on_success = handler(controller, result, :success)
+        self.on_failure = handler(controller, result, :failure)
+      end
+    end
+
+    def to_html
+      super && return if !(on_success || on_failure)
+      has_errors? ? controller.instance_exec(&on_failure) : controller.instance_exec(&on_success)
+    end
+
+    def to_format
+      super && return if !(on_success || on_failure)
+      has_errors? ? controller.instance_exec(&on_failure) : controller.instance_exec(&on_success)
+    end
+
+    private
+
+    def handler(controller, result, status)
+      return result if result.respond_to? :call
+
+      case result
+      when Hash
+        if result[status].is_a? Symbol
+          controller.method(result[status])
+        else
+          result[status]
+        end
+      when Symbol
+        controller.method(result)
+      end
+    end
+  end
+end

data/lib/solidus_responders/version.rb

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

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: solidus_responders
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Graham Bouvier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: factory_girl
+  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-rails
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.43'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.43'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: sqlite3
+  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: Removing responders out of solidus core
+email: graham@stembolt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/spree/base_controller_decorator.rb
+- lib/solidus_responders.rb
+- lib/solidus_responders/controller_helpers/respond_with.rb
+- lib/solidus_responders/engine.rb
+- lib/solidus_responders/responder.rb
+- lib/solidus_responders/version.rb
+homepage: 
+licenses:
+- BSD-3-Clause
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Provide custom responders for Solidus
+test_files: []