slotmachine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2281198bcb524876b314972ead2c826386193349
+  data.tar.gz: d740f4abfa0e853b81481bb9f7430b98d9f5d1ee
+SHA512:
+  metadata.gz: 3f2ca18a9a64f4d4634fc90d27952a3e086f4748388bb462db31ce7ce6dfb8c81a86d1b98ae9e18d5df5c0b4c3d5c55f009cff8e31ad8ca331d18d34c107a5e3
+  data.tar.gz: bb5ce7aadc08b0e8ee655eef878093d92336e40af865f82bb5160f70b5c63bab6cf52fc141f9629999f6dae4663b38c6e3521982a53aec4d68742fcd4e27a06a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Cedric Feyaerts
+
+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,144 @@
+# SlotMachine
+
+Slot Machine is a rails plugin to help you write clean, readable views. It hides the ugly css in partials away from your views.
+Slot Machine transforms partials into helper methods. Each partial contains slots into which you can insert data, html or other partials.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slot_machine'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install slot_machine
+```
+
+Create an initializer : `config/initializers/slot_machine.rb`
+```ruby
+require "slot_machine"
+
+# The path where your partials will be stored
+# default is Rails.root.join('app/views/slots/_*')
+SlotMachine::Config.path = MyEngine::Engine.root.join('app/views/slots/_*')
+```
+
+## Usage
+
+### The simplest case
+
+Create your first partial (app/views/slots/_my_first_partial.html.slim)
+
+```slim
+.my_first_partial #This is not required just an example
+  h2 = slots[:title]
+  h3 = slots[:subtitle]
+  .content
+    = slots[:content]
+```
+
+You can now write in your view:
+
+```slim
+= my_first_partial title: 'foo', subtitle: 'bar', content: 'awesome content'
+```
+
+or more usefull
+
+```slim
+= my_first_partial title: 'foo', subtitle: 'bar' do |mfp|
+  - mfp.slot :content
+    div this is great
+```
+### A more interesting example
+
+So far you could do the same with a partial. I know let's try something better.
+
+#### The slot main
+
+First there is a special slot by default: `slots[main]`
+
+_card.html.slim
+```slim
+.card
+  .card__title = slots[:title]
+  .card__content
+    = slots[:main] # yep that's the one
+```
+
+you can now do:
+
+```slim
+= card title: 'foo' do
+  div this is great
+```
+
+#### More then one slot
+
+_modal.html.slim
+```slim
+.modal
+  .modal__title = slots[:title]
+  .modal__content
+    = slots[:main]
+  .modal__footer
+    = slots[:footer]
+```
+
+It allows you to write something like this:
+
+```slim
+= modal title: 'foo' do |modal|
+  div hey look I'm a modal
+  - modal.slot :footer
+    div With a footer
+```
+
+#### And combine
+
+With the two partials from before (modal and card) we can now do this:
+
+```slim
+= modal title: 'foo' do |modal|
+  = card title: 'a card in a modal do
+    div And wait there is still more
+
+  - modal.slot :footer
+    = card title: 'a card in a modal's foot do
+      div My example are getting a bit far fetched
+```
+
+There is a shortener for that last one
+
+```slim
+= modal title: 'foo' do |modal|
+  - modal.card slot: :main, title: 'a card in a modal do
+    div And wait there is still more
+
+  - modal.card slot: :footer title: 'a card in a modal's foot do
+      div My example are getting a bit far fetched
+```
+
+You can also call the slot several times like thus:
+
+```slim
+= modal title: 'foo' do |modal|
+  - modal.card slot: :footer title: 'first card'
+  - modal.card slot: :footer title: 'second card'
+  - modal.card slot: :footer title: 'third card in a modal'
+```
+
+## What else?
+
+You noticed all my example are with slim. But it work great with yaml or erb.
+
+I also name my partials with the [BEM notation](http://getbem.com/). I find it easier to organise them by components specialy if you already use this same notation with your css.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SlotMachine'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/slot_machine.rb

@@ -0,0 +1,7 @@
+# Main module for Slot Machine
+module SlotMachine; end
+
+require 'slot_machine/config'
+require 'slot_machine/railtie'
+require 'slot_machine/helper'
+require 'slot_machine/application_controller_concern'

data/lib/slot_machine/application_controller_concern.rb

@@ -0,0 +1,9 @@
+# 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/config.rb

@@ -0,0 +1,31 @@
+# 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))
+      basename = basename.split('.').first
+      basename.slice!(0)
+      method_name = basename.parameterize.underscore.to_sym
+      partial = File.join('slots', basename)
+      [method_name, partial]
+    end
+
+    @slots = Hash[slots_array]
+  end
+
+  def self.method_names
+    @slots.keys
+  end
+
+  def self.partial(method_name)
+    @slots[method_name]
+  end
+
+  def self.path
+    @path || Rails.root.join('app/views/slots/_*')
+  end
+
+  def self.path=(value)
+    @path = value
+  end
+end

data/lib/slot_machine/helper.rb

@@ -0,0 +1,77 @@
+# 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

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

data/lib/slot_machine/version.rb

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

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: slotmachine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cedric Feyaerts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: It hide the ugly css and html from your views
+email:
+- c.feyaerts@adhoc-gti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-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/version.rb
+homepage: https://gitlab.com/cedricfeyaerts/slot-machine
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A Simple gem to write readable views
+test_files: []