class-action 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d42f5e13fe369f5658137e5442ad8074827a6093
-  data.tar.gz: 1ffcc823623757e1cc509831f7bb834c436112ac
+  metadata.gz: 80ec9cfa13cc143a616c0953168c6fc6c2b59fea
+  data.tar.gz: 850b188e163e61cce52c531378474690b8c80579
 SHA512:
-  metadata.gz: ab77feaaaf6fad427084fdcb666d25b409fd4aa6e54b46a4552f6d0999a5eac3255e1d08fee98a6f9172134c37ec080c754be7e481e4324554eb3d454ad61251
-  data.tar.gz: 12656d677d4f7c26dfc045d167826a20474b5bc2abb9171092aa4fbf48b100c82394020e6248c6bb1514c4a144d7cf2f21d5d23f0bfd006c8550fd42c2493d52
+  metadata.gz: 366e7e2722086aa9f2ff20f1aea4f96e55a4fba310ae7cd9bd81c729cc2e1160961e28174f6827271be70300052846a3239c051177a1ab75f03331775f4906b5
+  data.tar.gz: 73eb44ecc2fd1dbd8a64985c97a06674df295f5e348fbbc4f20f9290b2ade2bac4f61c4c58607aff25ff176ded33a71b001dfd7d57bd4f8f8476deba453143d2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.3.2 ##
+
+*   Autoloading mechanism added
+
 ## 1.3.1 ##
 
 *   Upgrade to Rails 4.1 and RSpec 3.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    class-action (1.3.0)
+    class-action (1.3.1)
       activesupport
 
 GEM

data/README.md

@@ -37,6 +37,26 @@ In your controller, make sure you have included `ClassAction`, and declare which
       class_action :show
     end
 
+### Organize your files
+
+ClassAction comes with an autoloading mechanism for actions. If you have the following file structure:
+
+    - app
+      |- controllers
+         |- posts_controller.rb
+            |- actions
+               |- index_action.rb
+               |- show_action.rb
+
+You need to tell ClassAction where the actions are located. You can do that by setting variable `action_load_path`:
+
+    class PostsController
+      include ClassAction
+      self.action_load_path << File.expand_path('../actions/*.rb', __FILE__)
+
+      class_action :index, :show
+    end
+
 ### Create an action
 
 Then, create your `show` action class (the default is to name this class `PostsController::Show`, but you may customize this).
@@ -117,7 +137,7 @@ However, `ClassAction` provides a bit more support for responses. You may define
 
     end
 
-This employs the use of `ActionController#respond_to`. Additionally, there is support for the Rails 3 style `respond_with`. To illustrate, this:
+This employs the use of `ActionController#respond_to`. Additionally, there is support for the Rails 3+ style `respond_with`. To illustrate, this:
 
     class Show < ClassAction::Action
 

data/lib/class_action/version.rb

@@ -1,3 +1,3 @@
 module ClassAction
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/lib/class_action.rb

@@ -8,6 +8,7 @@ module ClassAction
   class << self
     def included(target)
       target.extend ClassMethods
+      target.action_load_path = []
       setup target
     end
 
@@ -22,9 +23,11 @@ module ClassAction
 
   module ClassMethods
 
+    attr_accessor :action_load_path
+
     def class_action(*actions, klass: nil)
       actions.each do |action|
-        action_class = klass || const_get("#{action.to_s.camelize}Action")
+        action_class = klass || find_action_class(action)
         raise ArgumentError, "ClassAction does not support anonymous classes" if action_class.name.nil?
 
         class_eval <<-RUBY, __FILE__, __LINE__+1
@@ -58,8 +61,49 @@ module ClassAction
       end
     end
 
+    protected
+
+    def find_action_class(action)
+      class_name = "#{action.to_s.camelize}Action"
+      return const_get(class_name) if const_defined?(class_name)
+
+      if action_load_path.present?
+        load_action_class action
+      else
+        raise LoadError, "action class #{name}::#{class_name} not found and no action_load_path defined"
+      end
+    end
+
     private
 
+    def load_action_class(action)
+      basename = "#{action}_action"
+
+      path = path_for_action(basename) or
+        raise LoadError, "file '#{basename}.rb' not found in the load path for #{name}"
+
+      # Require the path
+      ActiveSupport::Dependencies.require path
+
+      # Try again
+      class_name = basename.camelize
+      if const_defined?(class_name)
+        const_get(class_name)
+      else
+        raise LoadError, "expected file '#{path}' to define action class #{class_name} but it was not defined"
+      end
+    end
+
+    def path_for_action(basename)
+      [*action_load_path].each do |path|
+        path = Dir.glob(path).find do |p|
+          File.basename(p, '.rb') == basename
+        end
+        return path if path
+      end
+      nil
+    end
+
     # Injects the mimes (formats) that the action responds to into the controller
     # mimes_for_respond_to hash.
     def inject_class_action_mimes(action, klass)

data/spec/class_action_spec.rb

@@ -22,6 +22,64 @@ describe ClassAction do
     end
   end
 
+  describe 'lazy loading' do
+
+    let(:action_load_path) { %w(app/controllers/my_controller/actions/*.rb app/controllers/my_controller/other_actions/*.rb) }
+
+    before do
+      # Fake three files
+      allow(Dir).to receive(:glob).with(action_load_path[0]).and_return(
+        ['app/controllers/my_controller/actions/first_action.rb']
+      )
+      allow(Dir).to receive(:glob).with(action_load_path[1]).and_return(
+        ['app/controllers/my_controller/actions/second_action.rb', 'app/controllers/my_controller/actions/third_action.rb']
+      )
+
+      allow(ActiveSupport::Dependencies).to receive(:require) do |arg|
+        case arg
+          when 'app/controllers/my_controller/actions/first_action.rb'
+            class ::ClassActionTestController::FirstAction < ActionController::Base; end
+
+          when 'app/controllers/my_controller/actions/second_action.rb'
+            # Incorrect name
+            class ::ClassActionTestController::NotSecondAction < ActionController::Base; end
+
+          when 'app/controllers/my_controller/actions/third_action.rb'
+            class ::ClassActionTestController::ThirdAction < ActionController::Base; end
+        end
+      end
+    end
+
+    before do
+      allow(ClassActionTestController).to receive(:action_load_path).and_return(action_load_path)
+    end
+
+    it "should raise an error if the class is not found and no load path is specified" do
+      allow(ClassActionTestController).to receive(:action_load_path).and_return([])
+      expect { ClassActionTestController.send(:find_action_class, :first) }
+        .to raise_error("action class ClassActionTestController::FirstAction not found and no action_load_path defined")
+    end
+
+    it "should find FirstAction" do
+      expect(ClassActionTestController.send(:find_action_class, :first)).to be(ClassActionTestController::FirstAction)
+    end
+
+    it "should find ThirdAction" do
+      expect(ClassActionTestController.send(:find_action_class, :third)).to be(ClassActionTestController::ThirdAction)
+    end
+
+    it "should raise an error if no file was found in the load path" do
+      expect { ClassActionTestController.send(:find_action_class, :fourth) }
+        .to raise_error(LoadError, "file 'fourth_action.rb' not found in the load path for ClassActionTestController")
+    end
+
+    it "should raise an error on second as the wrong class is defined there" do
+      expect { ClassActionTestController.send(:find_action_class, :second) }
+        .to raise_error(LoadError, "expected file 'app/controllers/my_controller/actions/second_action.rb' to define action class SecondAction but it was not defined")
+    end
+
+  end
+
   context "adding a class action :show" do
 
     before { ClassActionTestController.class_eval { class_action :show } }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: class-action
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Joost Lubach