lotus-view 0.1.0 → 0.2.0

data/lib/lotus/view.rb

@@ -1,6 +1,8 @@
 require 'set'
 require 'pathname'
+require 'lotus/utils/class_attribute'
 require 'lotus/view/version'
+require 'lotus/view/configuration'
 require 'lotus/view/inheritable'
 require 'lotus/view/rendering'
 require 'lotus/view/dsl'
@@ -41,145 +43,251 @@ module Lotus
     class MissingFormatError < ::StandardError
     end
 
-    # Register a view
+    include Utils::ClassAttribute
+
+    # Framework configuration
     #
+    # @since 0.2.0
     # @api private
-    # @since 0.1.0
+    class_attribute :configuration
+    self.configuration = Configuration.new
+
+    # Configure the framework.
+    # It yields the given block in the context of the configuration
+    #
+    # @param blk [Proc] the configuration block
+    #
+    # @since 0.2.0
+    #
+    # @see Lotus::View::Configuration
     #
     # @example
     #   require 'lotus/view'
     #
-    #   class IndexView
-    #     include Lotus::View
+    #   Lotus::View.configure do
+    #     root '/path/to/root'
     #   end
-    def self.included(base)
-      base.class_eval do
-        extend Inheritable.dup
-        extend Dsl.dup
-        extend Rendering.dup
-      end
-
-      views.add(base)
+    def self.configure(&blk)
+      configuration.instance_eval(&blk)
     end
 
-    # Set the directory root where templates are located
+    # Duplicate Lotus::View in order to create a new separated instance
+    # of the framework.
     #
-    # @param root [String] the root path
+    # The new instance of the framework will be completely decoupled from the
+    # original. It will inherit the configuration, but all the changes that
+    # happen after the duplication, won't be reflected on the other copies.
     #
-    # @see Lotus::View.root
+    # @return [Module] a copy of Lotus::View
     #
-    # @since 0.1.0
+    # @since 0.2.0
+    # @api private
     #
-    # @example
+    # @example Basic usage
     #   require 'lotus/view'
     #
-    #   Lotus::View.root = '/path/to/templates'
-    def self.root=(root)
-      @root = Pathname.new(root) rescue nil
-    end
-
-    # Returns the directory root where templates are located.
-    # If not already set, it returns the current directory.
-    #
-    # @return [Pathname] the root path for templates
+    #   module MyApp
+    #     View = Lotus::View.dupe
+    #   end
     #
-    # @see Lotus::View.root=
+    #   MyApp::View == Lotus::View # => false
     #
-    # @since 0.1.0
+    #   MyApp::View.configuration ==
+    #     Lotus::View.configuration # => false
     #
-    # @example with already set value
+    # @example Inheriting configuration
     #   require 'lotus/view'
     #
-    #   Lotus::View.root = '/path/to/templates'
-    #   Lotus::View.root # => #<Pathname:/path/to/templates>
+    #   Lotus::View.configure do
+    #     root '/path/to/root'
+    #   end
     #
-    # @example with missing set value
-    #   require 'lotus/view'
+    #   module MyApp
+    #     View = Lotus::View.dupe
+    #   end
+    #
+    #   module MyApi
+    #     View = Lotus::View.dupe
+    #     View.configure do
+    #       root '/another/root'
+    #     end
+    #   end
     #
-    #   Lotus::View.root # => #<Pathname:.>
-    def self.root
-      @root ||= begin
-        self.root = '.'
-        @root
+    #   Lotus::View.configuration.root # => #<Pathname:/path/to/root>
+    #   MyApp::View.configuration.root # => #<Pathname:/path/to/root>
+    #   MyApi::View.configuration.root # => #<Pathname:/another/root>
+    def self.dupe
+      dup.tap do |duplicated|
+        duplicated.configuration = configuration.duplicate
       end
     end
 
-    # Sets the default layout for all the registered views.
+    # Duplicate the framework and generate modules for the target application
     #
-    # @param layout [Symbol] the layout name
+    # @param mod [Module] the Ruby namespace of the application
+    # @param views [String] the optional namespace where the application's
+    #   views will live
+    # @param blk [Proc] an optional block to configure the framework
     #
-    # @since 0.1.0
+    # @return [Module] a copy of Lotus::View
     #
-    # @see Lotus::View::Dsl#layout
-    # @see Lotus::View.load!
+    # @since 0.2.0
     #
-    # @example
+    # @see Lotus::View#dupe
+    # @see Lotus::View::Configuration
+    # @see Lotus::View::Configuration#namespace
+    #
+    # @example Basic usage
     #   require 'lotus/view'
     #
-    #   Lotus::View.layout = :application
+    #   module MyApp
+    #     View = Lotus::View.duplicate(self)
+    #   end
     #
-    #   class IndexView
-    #     include Lotus::View
+    #   # It will:
+    #   #
+    #   # 1. Generate MyApp::View
+    #   # 2. Generate MyApp::Layout
+    #   # 3. Generate MyApp::Views
+    #   # 4. Configure MyApp::Views as the default namespace for views
+    #
+    #  module MyApp::Views::Dashboard
+    #    class Index
+    #      include MyApp::View
+    #    end
+    #  end
+    #
+    # @example Compare code
+    #   require 'lotus/view'
+    #
+    #   module MyApp
+    #     View = Lotus::View.duplicate(self) do
+    #       # ...
+    #     end
     #   end
     #
-    #   Lotus::View.load!
-    #   IndexView.layout # => ApplicationLayout
-    def self.layout=(layout)
-      @layout = Rendering::LayoutFinder.find(layout)
-    end
-
-    # Returns the default layout to assign to the registered views.
-    # If not already set, it returns a <tt>Rendering::NullLayout</tt>.
+    #   # it's equivalent to:
     #
-    # @return [Class,Rendering::NullLayout] depends if already set or not.
+    #   module MyApp
+    #     View   = Lotus::View.dupe
+    #     Layout = Lotus::Layout.dup
     #
-    # @since 0.1.0
+    #     module Views
+    #     end
     #
-    # @see Lotus::View.layout=
-    def self.layout
-      @layout ||= Rendering::NullLayout
-    end
-
-    # A set of registered views.
+    #     View.configure do
+    #       namespace 'MyApp::Views'
+    #     end
     #
-    # @return [Set] all the registered views.
+    #     View.configure do
+    #       # ...
+    #     end
+    #   end
     #
-    # @api private
-    # @since 0.1.0
-    def self.views
-      @views ||= Set.new
+    # @example Custom views module
+    #   require 'lotus/view
+    #
+    #   module MyApp
+    #     View = Lotus::View.duplicate(self, 'Vs')
+    #   end
+    #
+    #   defined?(MyApp::Views) # => nil
+    #   defined?(MyApp::Vs)    # => "constant"
+    #
+    #   # Developers can namespace views under Vs
+    #   module MyApp::Vs::Dashboard
+    #     # ...
+    #   end
+    #
+    # @example Nil views module
+    #   require 'lotus/view'
+    #
+    #   module MyApp
+    #     View = Lotus::View.duplicate(self, nil)
+    #   end
+    #
+    #   defined?(MyApp::Views) # => nil
+    #
+    #   # Developers can namespace views under MyApp
+    #   module MyApp
+    #     # ...
+    #   end
+    #
+    # @example Block usage
+    #   require 'lotus/view'
+    #
+    #   module MyApp
+    #     View = Lotus::View.duplicate(self) do
+    #       root '/path/to/root'
+    #     end
+    #   end
+    #
+    #   Lotus::View.configuration.root # => #<Pathname:.>
+    #   MyApp::View.configuration.root # => #<Pathname:/path/to/root>
+    def self.duplicate(mod, views = 'Views', &blk)
+      dupe.tap do |duplicated|
+        mod.module_eval %{ module #{ views }; end } if views
+        mod.module_eval %{ Layout = Lotus::Layout.dup }
+
+        duplicated.configure do
+          namespace [mod, views].compact.join '::'
+        end
+
+        duplicated.configure(&blk) if block_given?
+      end
     end
 
-    # A set of registered layouts.
+    # Override Ruby's hook for modules.
+    # It includes basic Lotus::View modules to the given Class.
+    # It sets a copy of the framework configuration
     #
-    # @return [Set] all the registered layout.
+    # @param base [Class] the target view
     #
-    # @api private
     # @since 0.1.0
-    def self.layouts
-      @layouts ||= Set.new
-    end
+    # @api private
+    #
+    # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
+    #
+    # @see Lotus::View::Dsl
+    # @see Lotus::View::Inheritable
+    # @see Lotus::View::Rendering
+    #
+    # @example
+    #   require 'lotus/view'
+    #
+    #   class IndexView
+    #     include Lotus::View
+    #   end
+    def self.included(base)
+      conf = self.configuration
+      conf.add_view(base)
 
-    #FIXME extract a Loader class
-    def self.load!
-      root.freeze
-      layout.freeze
-      views.freeze
+      base.class_eval do
+        extend Inheritable.dup
+        extend Dsl.dup
+        extend Rendering.dup
 
-      views.each do |view|
-        view.send(:load!)
-      end
+        include Utils::ClassAttribute
+        class_attribute :configuration
 
-      layouts.each do |layout|
-        layout.send(:load!)
+        self.configuration = conf.duplicate
       end
     end
 
+    # Load the framework
+    #
+    # @since 0.1.0
+    # @api private
+    def self.load!
+      configuration.load!
+    end
+
+    # Unload the framework
+    #
+    # @since 0.1.0
+    # @api private
     def self.unload!
-      instance_variable_set(:@root, nil)
-      instance_variable_set(:@layout, nil)
-      instance_variable_set(:@views, Set.new)
-      instance_variable_set(:@layouts, Set.new)
+      configuration.unload!
     end
   end
 end

data/lotus-view.gemspec

@@ -13,13 +13,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'http://lotusrb.org'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md lotus-view.gemspec`.split($/)
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'tilt',        '~> 2.0', '>= 2.0.1'
-  spec.add_runtime_dependency 'lotus-utils', '~> 0.1'
+  spec.add_runtime_dependency 'lotus-utils', '~> 0.2'
 
   spec.add_development_dependency 'bundler',  '~> 1.5'
   spec.add_development_dependency 'minitest', '~> 5'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotus-view
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-23 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -93,17 +93,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
-- Gemfile
-- LICENSE.txt
+- CHANGELOG.md
+- LICENSE.md
 - README.md
-- Rakefile
 - lib/lotus-view.rb
 - lib/lotus/layout.rb
 - lib/lotus/presenter.rb
 - lib/lotus/view.rb
+- lib/lotus/view/configuration.rb
 - lib/lotus/view/dsl.rb
 - lib/lotus/view/inheritable.rb
 - lib/lotus/view/rendering.rb
@@ -118,39 +115,12 @@ files:
 - lib/lotus/view/rendering/scope.rb
 - lib/lotus/view/rendering/template.rb
 - lib/lotus/view/rendering/template_finder.rb
+- lib/lotus/view/rendering/template_name.rb
 - lib/lotus/view/rendering/templates_finder.rb
 - lib/lotus/view/rendering/view_finder.rb
 - lib/lotus/view/template.rb
 - lib/lotus/view/version.rb
 - lotus-view.gemspec
-- test/fixtures.rb
-- test/fixtures/templates/app/app_view.html.erb
-- test/fixtures/templates/app/view.html.erb
-- test/fixtures/templates/application.html.erb
-- test/fixtures/templates/articles/_form.html.erb
-- test/fixtures/templates/articles/alternative_new.html.erb
-- test/fixtures/templates/articles/index.atom.erb
-- test/fixtures/templates/articles/index.html.erb
-- test/fixtures/templates/articles/index.json.erb
-- test/fixtures/templates/articles/index.rss.erb
-- test/fixtures/templates/articles/new.html.erb
-- test/fixtures/templates/articles/show.html.erb
-- test/fixtures/templates/articles/show.json.erb
-- test/fixtures/templates/contacts/show.html.haml
-- test/fixtures/templates/dashboard/index.html.erb
-- test/fixtures/templates/hello_world_view.html.erb
-- test/fixtures/templates/index_view.html.erb
-- test/fixtures/templates/json_render_view.json.erb
-- test/fixtures/templates/render_view.html.erb
-- test/fixtures/templates/shared/_sidebar.html.erb
-- test/layout_test.rb
-- test/load_test.rb
-- test/presenter_test.rb
-- test/rendering_test.rb
-- test/root_test.rb
-- test/test_helper.rb
-- test/version_test.rb
-- test/view_test.rb
 homepage: http://lotusrb.org
 licenses:
 - MIT
@@ -175,33 +145,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: View layer for Lotus, with a separation between views and templates
-test_files:
-- test/fixtures.rb
-- test/fixtures/templates/app/app_view.html.erb
-- test/fixtures/templates/app/view.html.erb
-- test/fixtures/templates/application.html.erb
-- test/fixtures/templates/articles/_form.html.erb
-- test/fixtures/templates/articles/alternative_new.html.erb
-- test/fixtures/templates/articles/index.atom.erb
-- test/fixtures/templates/articles/index.html.erb
-- test/fixtures/templates/articles/index.json.erb
-- test/fixtures/templates/articles/index.rss.erb
-- test/fixtures/templates/articles/new.html.erb
-- test/fixtures/templates/articles/show.html.erb
-- test/fixtures/templates/articles/show.json.erb
-- test/fixtures/templates/contacts/show.html.haml
-- test/fixtures/templates/dashboard/index.html.erb
-- test/fixtures/templates/hello_world_view.html.erb
-- test/fixtures/templates/index_view.html.erb
-- test/fixtures/templates/json_render_view.json.erb
-- test/fixtures/templates/render_view.html.erb
-- test/fixtures/templates/shared/_sidebar.html.erb
-- test/layout_test.rb
-- test/load_test.rb
-- test/presenter_test.rb
-- test/rendering_test.rb
-- test/root_test.rb
-- test/test_helper.rb
-- test/version_test.rb
-- test/view_test.rb
+test_files: []
 has_rdoc: 

data/.gitignore

@@ -1,8 +0,0 @@
-.devnotes
-.greenbar
-Gemfile.lock
-coverage/
-.yardoc/
-doc/
-*.gem
-.bundle

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-script: 'bundle exec rake test:coverage'
-rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1

data/.yardopts

@@ -1,3 +0,0 @@
--
-LICENSE.txt
-lib/**/*.rb

data/Gemfile

@@ -1,15 +0,0 @@
-source 'https://rubygems.org'
-
-if !ENV['TRAVIS']
-  gem 'byebug',      require: false, platforms: :ruby if RUBY_VERSION == '2.1.1'
-  gem 'yard',        require: false
-  gem 'lotus-utils', require: false, path: '../lotus-utils'
-else
-  gem 'lotus-utils'
-end
-
-gem 'rake'
-gem 'tilt', '~> 2.0.1', '>= 2.0.1'
-gem 'haml',      require: false
-gem 'simplecov', require: false
-gem 'coveralls', require: false

data/Rakefile

@@ -1,17 +0,0 @@
-require 'rake'
-require 'rake/testtask'
-require 'bundler/gem_tasks'
-
-Rake::TestTask.new do |t|
-  t.pattern = 'test/**/*_test.rb'
-  t.libs.push 'test'
-end
-
-namespace :test do
-  task :coverage do
-    ENV['COVERAGE'] = 'true'
-    Rake::Task['test'].invoke
-  end
-end
-
-task default: :test

data/test/fixtures/templates/application.html.erb

@@ -1,10 +0,0 @@
-<html>
-  <head>
-    <title><%= title %></title>
-  </head>
-
-  <body>
-    <%= render partial: 'shared/sidebar' %>
-    <%= yield %>
-  </body>
-</html>

data/test/fixtures/templates/articles/_form.html.erb

@@ -1,4 +0,0 @@
-<form>
-  <input type="hidden" name="secret" value="<%= secret %>" />
-  <input type="text" name="article[title]" value="<%= article.title %>" />
-</form>

data/test/fixtures/templates/articles/alternative_new.html.erb

@@ -1 +0,0 @@
-<%= render template: 'articles/new', locals: { errors: {} } %>

data/test/fixtures/templates/articles/index.atom.erb

@@ -1,5 +0,0 @@
-<entry>
-  <% articles.each do |article| %>
-  <title><%= article.title %></title>
-  <% end %>
-<entry>

data/test/fixtures/templates/articles/index.html.erb

@@ -1,3 +0,0 @@
-<% articles.each do |article| %>
-  <h1><%= article.title %></h1>
-<% end %>

data/test/fixtures/templates/articles/index.json.erb

@@ -1,9 +0,0 @@
-{
-  "articles": [
-  <% articles.each do |article| %>
-    "article":{
-    "title":"<%= article.title %>"
-    }
-  <% end %>
-  ]
-}

data/test/fixtures/templates/articles/new.html.erb

@@ -1,7 +0,0 @@
-<h1>New Article</h1>
-
-<% if errors.any? %>
-  <h2>Errors</h2>
-<% end %>
-
-<%= render partial: 'articles/form', locals: { secret: 23 } %>

data/test/fixtures/templates/articles/show.html.erb

@@ -1 +0,0 @@
-<h1><%= title %></h1>

data/test/fixtures/templates/articles/show.json.erb

@@ -1,5 +0,0 @@
-{
-  article: {
-    "title":"<%= title %>"
-  }
-}

data/test/fixtures/templates/contacts/show.html.haml

@@ -1 +0,0 @@
-%h1= person.name

data/test/fixtures/templates/dashboard/index.html.erb

@@ -1,2 +0,0 @@
-<h1>Map</h1>
-<h2><%= map.count %> locations</h2>

data/test/fixtures/templates/hello_world_view.html.erb

@@ -1 +0,0 @@
-<h1>Hello, World!</h1>

data/test/fixtures/templates/index_view.html.erb

@@ -1 +0,0 @@
-<h1>Welcome</h1>

data/test/fixtures/templates/json_render_view.json.erb

@@ -1,3 +0,0 @@
-{
-"greet":"Hello, <%= planet %>!"
-}

data/test/fixtures/templates/render_view.html.erb

@@ -1 +0,0 @@
-<h1>Hello, <%= planet %>!</h1>

data/test/fixtures/templates/shared/_sidebar.html.erb

@@ -1 +0,0 @@
-<div id="sidebar"></div>