sinatra-fuzzy_layout 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fc2719e1a696966d44c55d0ecc4a7bbfbd13724
+  data.tar.gz: 418e7bc2ce86f54f786df88fb3e15ac70d92f809
+SHA512:
+  metadata.gz: 8a5f11a749f273bd4bba5d4e2244956085cd2fb98c6f725a36e06c73d0c63c0ae06f291fd9918c67ce60ce336de8a904433bbeb9ea64f498a92783e241306aca
+  data.tar.gz: a04031df07c8bfa493c94adea7965be242eec0737de0c157c468e4b0d7f32e942c917b6960c399ecac32515054808b0a1a6e8f721a35d47c9a0c21529cecbf83

data/README.md

@@ -0,0 +1,133 @@
+# Sinatra::FuzzyLayout
+
+Enable or Disable `layout.<extension>` via regex.
+
+How many times did you wished you could do something like this:
+
+```ruby
+
+class App < Sinatra::Base
+  
+  register Sinatra::FuzzyLayout
+
+  enable_layout_for "home", :admin
+  disable_layout_for /.+_reports/
+
+  get '/' do
+    haml :index             # layout.haml is used
+  end
+
+  get '/admin' do
+    haml :admin             # layout.haml is used
+  end
+
+  get '/home' do
+    haml :home              # layout.haml is used
+  end
+
+  get '/system_reports' do
+    haml :system_reports    # layout.haml is not used.
+  end
+
+end
+```
+
+Never? 
+
+k.
+
+
+## Installation
+
+Run this:
+
+    gem install 'sinatra-fuzzy_layout'
+
+Or, if your use bundler like the pros, add this line to 
+your application's Gemfile:
+
+    gem 'sinatra-fuzzy_layout'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Once the gem is installed, add this in your app file:
+
+    require 'sinatra/fuzzy_layout'
+
+
+#### Classic Style
+
+Once you `require` the gem, you can define the `enable_layout_for` and/or 
+`disable_layout_for` end-points
+
+#### Modular Style
+
+An additional step in case of Modular style apps is :
+
+```ruby
+require "sinatra/fuzzy_layout" # just like in classic style
+
+class App < Sinatra::Base
+
+  register Sinatra::FuzzyLayout
+
+  enable_layout_for :a_template
+end
+```
+
+Done.
+
+## How it works
+
+(Note: if you use a different templating engine like `slim` or `erb`, 
+replace all instances of `haml` with that engine here on)
+
+When the app encounters a `haml :view` in a route, 
+it tries to render that view by reading the `view.haml` file and checking 
+to see if a `layout` option is defined. This usually is set at a global 
+level in the app `set :haml, :layout => false` or set on a per-route 
+basis `haml :view, :layout => false`. If the layout is required, then the 
+`layout.haml` is also parsed and the `view.haml` part is added to the 
+layout. 
+
+This extension lets you define the layout options at a global level. 
+It modifies the `render` method in `Sinatra::Templates` so that the templates 
+are checked against the regexes defined and the layout option is set 
+(or unset) based on the result.
+
+
+A template is first validated against the `enable_layouts_for` options. If the 
+`enable_layouts_for` directive is not defined in the app however, the check 
+only happens against `disable_layouts_for`. If the first check returns true, 
+i.e., if the layout is enabled for that template, the second check never 
+happens. This means that if you define a template in both the 
+`enable_layouts_for` and `disable_layouts_for` directives, the layout gets enabled 
+since the first check returns true.
+
+Typically, only one template is used in each route (duh!). This means 
+that the regex checks happen only one in the best case and 
+twice in the worst case and so should not affect performance by a large 
+margin. However, if you are writing at webscale, you might want to skip 
+this.
+
+Even if you use this plugin, it won't interfere with the normal Sinatra 
+layout directives (global and per-route) and so, you can mix-and-match if 
+you're into it. If you're still uncertain whether or not to use it, but 
+want to, I'd say go ahead.
+
+
+## Contributing
+
+Lulz. Really?
+
+Okay.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sinatra/fuzzy_layout.rb

@@ -0,0 +1,69 @@
+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
+
+module Sinatra
+
+  module FuzzyLayout
+
+    module TemplatesHelpers
+      include Sinatra::Templates
+
+      def render(engine, data, options = {}, locals = {}, &block)
+        options = get_new_options_and_template(options, data)
+        super
+      end
+
+      private
+
+      def get_new_options_and_template(options, template)
+        if settings.enable_list.has_the_template?(template)
+          options[:layout] = true
+        elsif settings.disable_list.has_the_template?(template)
+          options[:layout] = false
+        end
+
+        options
+      end
+    end
+
+    def enable_layout_for(*templates)
+      Base.set :enable_list, templates || []
+    end
+
+    def disable_layout_for(*templates)
+      Base.set :disable_list, templates || []
+    end
+
+    def self.registered(app)
+      app.helpers FuzzyLayout::TemplatesHelpers
+    end
+  end
+
+  register FuzzyLayout
+end
+

data/spec/fuzzy_layout_spec.rb

@@ -0,0 +1,85 @@
+require_relative "spec_helper"
+require_relative "sample_app"
+require_relative "sample_app_multiple"
+
+describe 'Test App with single declaration of enable or disable directives' do
+
+  def app
+    SampleApp
+  end
+
+  it "disables layout if route level :layout => false is set" do
+    get('/')
+    last_response.should be_ok
+    last_response.body.should == "<em>Spartaa!!</em>\n"
+  end
+
+  it "enables layout when layout is both enabled and disabled" do
+    get('/one')
+    last_response.should be_ok
+    last_response.body.should == "<h1>This is <em>one</em></h1>\n"
+  end
+
+  it "works when template is specified as a string" do
+    get('/two')
+    last_response.should be_ok
+    last_response.body.should == "<em>two</em>\n"
+  end
+
+  context "works when template is specified as a regex" do
+    it "should not have a layout for the route four" do
+      get('/four')
+      last_response.should be_ok
+      last_response.body.should == "<em>four</em>\n"
+    end
+
+    it "should not have a layout for the route five" do
+      get('/five')
+      last_response.should be_ok
+      last_response.body.should == "<em>five</em>\n"
+    end
+  end
+
+end
+
+
+
+describe 'Test App with multiple declarations of enable directives' do
+
+  def app
+    SampleAppMultiple
+  end
+
+  it "disables layout if route level :layout => false is set" do
+    get('/')
+    last_response.should be_ok
+    last_response.body.should == "<em>Spartaa!!</em>\n"
+  end
+
+  it "enables layout when layout is both enabled and disabled" do
+    get('/one')
+    last_response.should be_ok
+    last_response.body.should == "<h1>This is <em>one</em></h1>\n"
+  end
+
+  it "works when template is specified as a string" do
+    get('/two')
+    last_response.should be_ok
+    last_response.body.should == "<em>two</em>\n"
+  end
+
+  context "works when template is specified as a regex" do
+    it "should not have a layout for the route four" do
+      get('/four')
+      last_response.should be_ok
+      last_response.body.should == "<em>four</em>\n"
+    end
+
+    it "should not have a layout for the route five" do
+      get('/five')
+      last_response.should be_ok
+      last_response.body.should == "<em>five</em>\n"
+    end
+  end
+
+end

data/spec/sample_app.rb

@@ -0,0 +1,20 @@
+require "sinatra/base"
+require "haml"
+require "sinatra/fuzzy_layout"
+
+class SampleApp < Sinatra::Base
+  register Sinatra::FuzzyLayout
+
+  enable_layout_for :one
+  disable_layout_for "one", "two", /f\w{3}/
+
+  get '/' do 
+    haml :index, :layout => false
+  end
+
+  get('/one') { haml :one }
+  get('/two') { haml :two }
+  get('/three') { haml :three }
+  get('/four') { haml :four }
+  get('/five') { haml :five }
+end

data/spec/sample_app_multiple.rb

@@ -0,0 +1,21 @@
+require "sinatra/base"
+require "haml"
+require "sinatra/fuzzy_layout"
+
+class SampleAppMultiple < Sinatra::Base
+  register Sinatra::FuzzyLayout
+
+  enable_layout_for :one
+  disable_layout_for "one"
+  disable_layout_for "two", /f\w{3}/
+
+  get '/' do 
+    haml :index, :layout => false
+  end
+
+  get('/one') { haml :one }
+  get('/two') { haml :two }
+  get('/three') { haml :three }
+  get('/four') { haml :four }
+  get('/five') { haml :five }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "rack/test"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.include Rack::Test::Methods
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/views/five.haml

@@ -0,0 +1 @@
+%em five

data/spec/views/five.slim

@@ -0,0 +1 @@
+em five

data/spec/views/four.haml

@@ -0,0 +1 @@
+%em four

data/spec/views/four.slim

@@ -0,0 +1 @@
+em four

data/spec/views/index.haml

@@ -0,0 +1 @@
+%em Spartaa!!

data/spec/views/index.slim

@@ -0,0 +1 @@
+em Spartaa!!

data/spec/views/layout.haml

@@ -0,0 +1 @@
+%h1 This is #{yield}

data/spec/views/layout.slim

@@ -0,0 +1 @@
+h1 This is #{yield}

data/spec/views/one.haml

@@ -0,0 +1 @@
+%em one

data/spec/views/one.slim

@@ -0,0 +1 @@
+em one

data/spec/views/three.haml

@@ -0,0 +1 @@
+%em three

data/spec/views/three.slim

@@ -0,0 +1 @@
+em three

data/spec/views/two.haml

@@ -0,0 +1 @@
+%em two

data/spec/views/two.slim

@@ -0,0 +1 @@
+em two

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-fuzzy_layout
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Kashyap
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: sinatra
+  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'
+description: "Provides ability to enable or disable layouts \n                          for
+  templates via Regex"
+email:
+- kashyap.kmbc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sinatra/fuzzy_layout.rb
+- Rakefile
+- README.md
+- spec/fuzzy_layout_spec.rb
+- spec/sample_app.rb
+- spec/sample_app_multiple.rb
+- spec/spec_helper.rb
+- spec/views/five.haml
+- spec/views/five.slim
+- spec/views/four.haml
+- spec/views/four.slim
+- spec/views/index.haml
+- spec/views/index.slim
+- spec/views/layout.haml
+- spec/views/layout.slim
+- spec/views/one.haml
+- spec/views/one.slim
+- spec/views/three.haml
+- spec/views/three.slim
+- spec/views/two.haml
+- spec/views/two.slim
+homepage: ''
+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.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
+test_files:
+- spec/fuzzy_layout_spec.rb
+- spec/sample_app.rb
+- spec/sample_app_multiple.rb
+- spec/spec_helper.rb
+- spec/views/five.haml
+- spec/views/five.slim
+- spec/views/four.haml
+- spec/views/four.slim
+- spec/views/index.haml
+- spec/views/index.slim
+- spec/views/layout.haml
+- spec/views/layout.slim
+- spec/views/one.haml
+- spec/views/one.slim
+- spec/views/three.haml
+- spec/views/three.slim
+- spec/views/two.haml
+- spec/views/two.slim
+has_rdoc: