sinatra-fuzzy_layout 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fc2719e1a696966d44c55d0ecc4a7bbfbd13724
-  data.tar.gz: 418e7bc2ce86f54f786df88fb3e15ac70d92f809
+  metadata.gz: 59c79a758df3a89091e7651f882fb7c33e4493e5
+  data.tar.gz: b0250e34e0f1277847914f6abc8e37a541a40f70
 SHA512:
-  metadata.gz: 8a5f11a749f273bd4bba5d4e2244956085cd2fb98c6f725a36e06c73d0c63c0ae06f291fd9918c67ce60ce336de8a904433bbeb9ea64f498a92783e241306aca
-  data.tar.gz: a04031df07c8bfa493c94adea7965be242eec0737de0c157c468e4b0d7f32e942c917b6960c399ecac32515054808b0a1a6e8f721a35d47c9a0c21529cecbf83
+  metadata.gz: dcad67d2e96111669ddb8c029449edac0d09371f09e9b537e471ef1af84c6e60bed2ede7b7fdd1364e91ecc75d50f4e03b9fedfafd49138298abc7dbf7047fa0
+  data.tar.gz: 3fc6d4d32e10b6e1e1dcbabe8c5e3e9c99c6de7eaa97bb60bab8d916d9c7b14e21f9bb4c0aca13be2ea8dfee20d89235539cd6da80eb61bdebd73f3d3d652883

data/lib/sinatra/core_ext/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def has_the_template?(arg)
+    self.select { |x| x.check arg }.any?
+  end
+end

data/lib/sinatra/core_ext/regexp.rb

@@ -0,0 +1,7 @@
+class Regexp
+  def check(arg)
+    false
+    true if self =~ arg
+  end
+end
+

data/lib/sinatra/core_ext/string.rb

@@ -0,0 +1,6 @@
+class String
+  def check(arg)
+    self === arg.to_s
+  end
+end
+

data/lib/sinatra/core_ext/symbol.rb

@@ -0,0 +1,6 @@
+class Symbol
+  def check(arg)
+    self === arg.to_sym
+  end
+end
+

data/lib/sinatra/fuzzy_layout.rb

@@ -1,37 +1,82 @@
 require "sinatra/base"
-
-class Array
-  def has_the_template?(arg)
-    self.select { |x| x.check arg }.any?
-  end
-end
-
-class Regexp
-  def check(arg)
-    false
-    true if self =~ arg
-  end
-end
-
-class String
-  def check(arg)
-    self === arg.to_s
-  end
-end
-
-
-class Symbol
-  def check(arg)
-    self === arg.to_sym
-  end
-end
+require_relative "core_ext/string.rb"
+require_relative "core_ext/regexp.rb"
+require_relative "core_ext/array.rb"
+require_relative "core_ext/symbol.rb"
 
 module Sinatra
 
+  # = Sinatra::FuzzyLayout
+  #
+  # <tt>Sinatra::FuzzyLayout</tt> is an extension to enable or disable
+  # layouts for views with much more control. By default, regular Sinatra
+  # provides two options:
+  # 1. You can specify whether the layout should be enabled/disabled
+  #    for all views.
+  # 2. You can specify whether the layout should be enabled/disabled
+  #    for an individual route/view.
+  #
+  # This extension provides two DSL methods `enable_layout_for` and
+  # `disable_layout_for` which accept multiple parameters using which you
+  # can have greater control over the layout-ing.
+  #
+  # == Usage
+  #
+  # In your application, you can use the `enable_layout_for` or
+  # `disable_layout_for` DSL methods to specify which route/view should
+  # have the layout and which routes/views should not.
+  #
+  #     enable_layout_for :index, :home, /user/
+  #
+  # All views that have the name "index", "home" or any view whose name
+  # matches the regex /user/ will have it's layout disabled.
+  #
+  #     disable_layout_for /reports/
+  #
+  # The layout will be disabled for all views that match the regex /reports/
+  # like "user_reports.slim" or "usage_reports.erb"
+  #
+  # === Classic Application
+  #
+  # To use the extension in a classic application, all you have to do is
+  # require it.
+  #
+  #     require "sinatra"
+  #     require "sinatra/fuzzy_layout"
+  #
+  #     enable_layout_for :index, :home, /user/
+  #     disable_layout_for /reports/
+  #
+  #     # rest of the application goes here
+  #
+  # === Modular Application
+  #
+  # To use this in a modular application, you need to `register` the
+  # extension like so:
+  #
+  #     require "sinatra/base"
+  #     require "sinatra/fuzzy_layout"
+  #
+  #     class App < Sinatra::Base
+  #       register Sinatra::FuzzyLayout
+  #
+  #       enable_layout_for :one, :two, :three
+  #
+  #       # rest of the application goes here
+  #     end
+  #
   module FuzzyLayout
 
+    # This module is a placeholder for the non-DSL methods. To know more
+    # about extending Sinatra or how the various bindings/encapsulation
+    # works, refer to [this material on the topic](http://www.sinatrarb.com/extensions.html)
+    #
+    # This module gets included inside the Sinatra::Base class within the
+    # call to `app.helpers TemplatesHelpers`. So we use the class hierarchy
+    # to our advantage and override the `render` method to obtain the name
+    # of the view and other options based on the name of the view.
+
     module TemplatesHelpers
-      include Sinatra::Templates
 
       def render(engine, data, options = {}, locals = {}, &block)
         options = get_new_options_and_template(options, data)
@@ -40,6 +85,17 @@ module Sinatra
 
       private
 
+
+      # Sets the layout option for a particular view template.
+      #
+      # == Parameters
+      # options::
+      #   A hash of options generated by the app based on the settings
+      #   by the user.
+      #
+      # template::
+      #   A Symbol representing the name of the view. For example, `:index`
+
       def get_new_options_and_template(options, template)
         if settings.enable_list.has_the_template?(template)
           options[:layout] = true
@@ -60,7 +116,7 @@ module Sinatra
     end
 
     def self.registered(app)
-      app.helpers FuzzyLayout::TemplatesHelpers
+      app.helpers TemplatesHelpers
     end
   end
 

data/spec/sample_app.rb

@@ -1,6 +1,6 @@
 require "sinatra/base"
 require "haml"
-require "sinatra/fuzzy_layout"
+require File.expand_path("../../lib/sinatra/fuzzy_layout.rb", __FILE__)
 
 class SampleApp < Sinatra::Base
   register Sinatra::FuzzyLayout

data/spec/sample_app_multiple.rb

@@ -1,6 +1,6 @@
 require "sinatra/base"
 require "haml"
-require "sinatra/fuzzy_layout"
+require File.expand_path("../../lib/sinatra/fuzzy_layout.rb", __FILE__)
 
 class SampleAppMultiple < Sinatra::Base
   register Sinatra::FuzzyLayout

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-fuzzy_layout
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Kashyap
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,38 +28,56 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 description: "Provides ability to enable or disable layouts \n                          for
-  templates via Regex"
+  multiple templates via Regex"
 email:
 - kashyap.kmbc@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/sinatra/core_ext/array.rb
+- lib/sinatra/core_ext/regexp.rb
+- lib/sinatra/core_ext/string.rb
+- lib/sinatra/core_ext/symbol.rb
 - lib/sinatra/fuzzy_layout.rb
 - Rakefile
 - README.md
@@ -93,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -105,9 +123,9 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: In Sinatra, the user can disable the layout  template either globally or
-  on a per template  basis in the individual routes. This module  will provide support
-  to enable or disable the  layout rendering based on Regex description.  Refer to
-  Readme for more details
+  on a per template  basis in the individual routes. This extension  will provide
+  support to enable or disable the  layout rendering based on Regex description.  Refer
+  to Readme for more details
 test_files:
 - spec/fuzzy_layout_spec.rb
 - spec/sample_app.rb