slotmachine 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2281198bcb524876b314972ead2c826386193349
-  data.tar.gz: d740f4abfa0e853b81481bb9f7430b98d9f5d1ee
+  metadata.gz: 2888bc896a4e6518d88c01b1fa1e9ecf39b07dd2
+  data.tar.gz: cb08aec43d4b45d705ca312b2c2a8dab1537d536
 SHA512:
-  metadata.gz: 3f2ca18a9a64f4d4634fc90d27952a3e086f4748388bb462db31ce7ce6dfb8c81a86d1b98ae9e18d5df5c0b4c3d5c55f009cff8e31ad8ca331d18d34c107a5e3
-  data.tar.gz: bb5ce7aadc08b0e8ee655eef878093d92336e40af865f82bb5160f70b5c63bab6cf52fc141f9629999f6dae4663b38c6e3521982a53aec4d68742fcd4e27a06a
+  metadata.gz: ece189ab4344b53364c7aafa4097691c4803e83ccd2ce8cf74e967572681d235eabf25a16a17bef2a777da3997188826c5aa31889088e48d80f15a00fcba21bd
+  data.tar.gz: cde30b1568177c73af6085c74d50bc83920bd9d36248e05c17c4dd06515b53a2e147a24d9434271749c79003287d1f02b1fce5a0a72a5339957278477a54cc90

data/README.md

@@ -29,6 +29,13 @@ require "slot_machine"
 SlotMachine::Config.path = MyEngine::Engine.root.join('app/views/slots/_*')
 ```
 
+And then in your application controller
+```ruby
+  include SlotMachine::ControllerConcern
+  helper slot_machine_helper(path: 'you_can_override_the_path_of_the_slots_here/_*')
+```
+
+
 ## Usage
 
 ### The simplest case

data/lib/slot_machine.rb

@@ -2,6 +2,4 @@
 module SlotMachine; end
 
 require 'slot_machine/config'
-require 'slot_machine/railtie'
-require 'slot_machine/helper'
-require 'slot_machine/application_controller_concern'
+require 'slot_machine/controller_concern'

data/lib/slot_machine/config.rb

@@ -1,12 +1,13 @@
 # Config where is store all informations
 module SlotMachine::Config
-  def self.read_slots
-    slots_array = Dir[path].map do |path|
-      basename = File.basename(path, File.extname(path))
+  def self.read_slots(custom_path = nil)
+    slots_array = Dir[custom_path || path].map do |p|
+      basename = File.basename(p, File.extname(p))
       basename = basename.split('.').first
       basename.slice!(0)
       method_name = basename.parameterize.underscore.to_sym
-      partial = File.join('slots', basename)
+      partial_path = File.dirname(p).split('/views/').last
+      partial = File.join(partial_path, basename)
       [method_name, partial]
     end
 
@@ -24,8 +25,4 @@ module SlotMachine::Config
   def self.path
     @path || Rails.root.join('app/views/slots/_*')
   end
-
-  def self.path=(value)
-    @path = value
-  end
 end

data/lib/slot_machine/controller_concern.rb

@@ -0,0 +1,102 @@
+# Helper to be included in application_controller
+module SlotMachine::ControllerConcern
+  # In the the view:
+  # `= foo label: 'toto' do 'something awesome' end`
+  #
+  # In the partial foo:
+  # `slots[:label] == label == 'toto'`
+  # `slots[:main] == main == 'something awesome'`
+  #
+  # so you should use `slots[:something]` when it could be unassigned
+  extend ActiveSupport::Concern
+
+  # A builder class base for the builder of the different partials
+  class Builder
+    attr_internal :slots
+
+    def initialize(template)
+      @template = template
+    end
+
+    # attribute reader
+    def slots
+      @slots ||= Hash.new { |h, k| h[k] = ActiveSupport::SafeBuffer.new('') }
+    end
+
+    def slot?(name)
+      !slots[name].blank?
+    end
+
+    # append the named slot
+    def append_slot(name = :main, string = nil, &block)
+      slots[name].concat(@template.get_buffer(string, &block))
+      nil # why the fuck do I need this. It shouldn't put anything in the buffer but it does.
+    end
+    alias_method :slot, :append_slot
+  end
+
+  class_methods do
+    # create the module to be called as a helper
+    # Typically :
+    # ```
+    #   include SlotMachine::ControllerConcern
+    #   helper slot_machine_create_module(my_path)
+    # ````
+    def slot_machine_helper(path: nil)
+      return @helper_module unless @helper_module.nil?
+
+      # Read slot on the custom path
+      slots = SlotMachine::Config.read_slots(path)
+      method_names = slots.keys
+
+      # Instantiate the new module
+      @helper_module = Module.new
+
+      # Create a child builder class with all the methods
+      builder_class = Class.new(Builder)
+
+      builder_class.class_eval do
+        method_names.each do |method_name|
+          define_method(method_name) do |args = { slot: :main }, &block|
+            slot_name = args.delete(:slot)
+            rendered_partial = @template.send(method_name, args, &block)
+            append_slot(slot_name, rendered_partial)
+          end
+        end
+      end
+
+      # Add 1 method per partial in the module as well
+      method_names.each do |method_name|
+        @helper_module.module_eval do
+          # this one should be in the builder but it doesnt have the builder method
+          def get_buffer(string = nil, &block)
+            return string unless block
+
+            capture { yield }
+          end
+          define_method(method_name) do |locals = {}, &block|
+            # that is some weird shit but il allow to access all the local_assigns
+            # within the slots and still access the directly
+            locals[:slots] = locals
+
+            # Here we create the builder
+            # we execute the block while passing the builder
+            # all the slotted partial will be in the builder
+            # and activeview buffer is captured and slotted
+            # in the main slot
+            if block
+              builder = builder_class.new(self)
+              captured = capture { block.call(builder) }
+              builder.append_slot(:main, captured)
+              locals[:slots] = locals[:slots].merge(builder.slots)
+              locals[:m] = builder
+            end
+            render slots[method_name], locals
+          end
+        end
+      end
+
+      @helper_module
+    end
+  end
+end

data/lib/slot_machine/version.rb

@@ -1,3 +1,3 @@
 module SlotMachine
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/slotmachine.rb

@@ -0,0 +1 @@
+require 'slot_machine'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slotmachine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cedric Feyaerts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,22 +24,21 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 4.0.0
-description: It hide the ugly css and html from your views
+description: Hides the ugly css and html from your views
 email:
 - c.feyaerts@adhoc-gti.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- LICENSE
 - README.md
 - Rakefile
 - lib/slot_machine.rb
-- lib/slot_machine/application_controller_concern.rb
 - lib/slot_machine/config.rb
-- lib/slot_machine/helper.rb
-- lib/slot_machine/railtie.rb
+- lib/slot_machine/controller_concern.rb
 - lib/slot_machine/version.rb
+- lib/slotmachine.rb
 homepage: https://gitlab.com/cedricfeyaerts/slot-machine
 licenses:
 - MIT

data/lib/slot_machine/application_controller_concern.rb

@@ -1,9 +0,0 @@
-# Module to be included in controller to enable the helpers
-# Usually in application_controller.rb
-module SlotMachine::ApplicationControllerConcern
-  extend ActiveSupport::Concern
-
-  included do
-    helper SlotMachine::Helper
-  end
-end

data/lib/slot_machine/helper.rb

@@ -1,77 +0,0 @@
-# Helper to be included in application_controller
-module SlotMachine::Helper
-  # In the the view:
-  # `= foo label: 'toto' do 'something awesome' end`
-  #
-  # In the partial foo:
-  # `slots[:label] == label == 'toto'`
-  # `slots[:main] == main == 'something awesome'`
-  #
-  # so you should use `slots[:something]` when it could be unassigned
-  extend ActiveSupport::Concern
-
-  included do
-    SlotMachine::Config.read_slots
-    SlotMachine::Config.method_names.each do |method_name|
-      define_method(method_name) do |locals = {}, &block|
-        # that is some weird shit but il allow to access all the local_assigns
-        # within the slots and still access the directly
-        locals[:slots] = locals
-
-        # Here we create the builder
-        # we execute the block while passing the builder
-        # all the slotted partial will be in the builder
-        # and activeview buffer is captured and slotted
-        # in the main slot
-        if block
-          builder = Builder.new(self)
-          captured = capture { block.call(builder) }
-          builder.append_slot(:main, captured)
-          locals[:slots] = locals[:slots].merge(builder.slots)
-          locals[:m] = builder
-        end
-        render SlotMachine::Config.partial(method_name), locals
-      end
-    end
-
-    # A builder for the different partial
-    class Builder
-      attr_internal :slots
-
-      def initialize(template)
-        @template = template
-      end
-
-      # attribute reader
-      def slots
-        @slots ||= Hash.new { |h, k| h[k] = ActiveSupport::SafeBuffer.new('') }
-      end
-
-      def slot?(name)
-        !slots[name].blank?
-      end
-
-      # append the named slot
-      def append_slot(name = :main, string = nil, &block)
-        slots[name].concat(@template.get_buffer(string, &block))
-        nil # why the fuck do I need this. It shouldn't put anything in the buffer but it does.
-      end
-      alias_method :slot, :append_slot
-
-      SlotMachine::Config.method_names.each do |method_name|
-        define_method(method_name) do |args = { slot: :main }, &block|
-          slot_name = args.delete(:slot)
-          rendered_partial = @template.send(method_name, args, &block)
-          append_slot(slot_name, rendered_partial)
-        end
-      end
-    end
-  end
-
-  # this one should be in the builder but it doesnt have the builder method
-  def get_buffer(string = nil, &block)
-    return string unless block
-
-    capture { yield }
-  end
-end

data/lib/slot_machine/railtie.rb

@@ -1,4 +0,0 @@
-class SlotMachine::Railtie < Rails::Railtie
-  config.to_prepare do
-  end
-end