panoramic 0.0.4 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3484de7a6c858f54f6201c48ea1316778c287e8
+  data.tar.gz: 348040f2ae3bec77b8b15972881554e22dfd1373
+SHA512:
+  metadata.gz: a33a457703b4537f021e126eb7013b08999f6da892d34153c75397627230cf8a3a5a9bda182437d49ab8234d5c42c5985544ca48c77a5793fa0cd6879f2a7623
+  data.tar.gz: b8de6b181357e5db23eaf7121bd849dbc7a0c3279d780fa5ff1b0c17d6347d13171d10a056a5154f66bef22d7d0e4e254c880b5c697ad7b5f4add18337f192e9

data/.gitignore

@@ -7,3 +7,5 @@ spec/dummy/tmp/
 .rspec
 coverage/*
 .rvmrc
+gemfiles/*.lock
+*.rdb

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 1.9.2
-  - 1.8.7
-  - ree
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 group :test do

data/Gemfile.lock

@@ -1,137 +1,150 @@
 PATH
   remote: .
   specs:
-    panoramic (0.0.4)
+    panoramic (0.0.6)
       rails (>= 3.0.7)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    actionmailer (3.2.6)
-      actionpack (= 3.2.6)
-      mail (~> 2.4.4)
-    actionpack (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-      builder (~> 3.0.0)
+    actionmailer (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      actionview (= 4.2.5.1)
+      activejob (= 4.2.5.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.5.1)
+      actionview (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
       erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.6)
-      activesupport (= 3.2.6)
-      builder (~> 3.0.0)
-    activerecord (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-    activesupport (3.2.6)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
-    capybara (1.1.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
+    activerecord (4.2.5.1)
+      activemodel (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      arel (~> 6.0)
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    capybara (2.5.0)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
-      selenium-webdriver (~> 2.0)
-      xpath (~> 0.1.4)
-    childprocess (0.3.0)
-      ffi (~> 1.0.6)
-    diff-lcs (1.1.3)
+      xpath (~> 2.0)
+    concurrent-ruby (1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
     erubis (2.7.0)
-    factory_girl (2.5.0)
-      activesupport
-    ffi (1.0.11)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.4)
-    json (1.7.3)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.0.4)
-    nokogiri (1.5.0)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.99.1)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    rack (1.6.4)
+    rack-test (0.6.3)
       rack (>= 1.0)
-    rails (3.2.6)
-      actionmailer (= 3.2.6)
-      actionpack (= 3.2.6)
-      activerecord (= 3.2.6)
-      activeresource (= 3.2.6)
-      activesupport (= 3.2.6)
-      bundler (~> 1.0)
-      railties (= 3.2.6)
-    railties (3.2.6)
-      actionpack (= 3.2.6)
-      activesupport (= 3.2.6)
-      rack-ssl (~> 1.3.2)
+    rails (4.2.5.1)
+      actionmailer (= 4.2.5.1)
+      actionpack (= 4.2.5.1)
+      actionview (= 4.2.5.1)
+      activejob (= 4.2.5.1)
+      activemodel (= 4.2.5.1)
+      activerecord (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.5.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
       rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    rspec-rails (2.10.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec (~> 2.10.0)
-    rubyzip (0.9.5)
-    selenium-webdriver (2.18.0)
-      childprocess (>= 0.2.5)
-      ffi (~> 1.0.9)
-      multi_json (~> 1.0.4)
-      rubyzip
-    simplecov (0.5.4)
-      multi_json (~> 1.0.3)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.5)
-    thor (0.15.4)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
-    xpath (0.1.4)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sprockets (3.5.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    xpath (2.0.0)
       nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  capybara (~> 1.1.2)
+  capybara (~> 2.5.0)
   factory_girl
   panoramic!
   rake
-  rspec-rails (~> 2.10.0)
+  rspec-rails (~> 3.0)
   simplecov
   sqlite3
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,4 +1,4 @@
-# Panoramic
+# Panoramic [![Build Status](https://secure.travis-ci.org/apeacox/panoramic.png)](http://travis-ci.org/apeacox/panoramic)
 An [ActionView::Resolver] implementation to store rails views (layouts, templates and partials) on database. Simply put: what you can do with views on filesystem, can be done on database.
 
 **NOTE:** at the moment, only ActiveRecord is supported, I've planned to add more ORMs (see Todo). If you can't wait, adding other ORMs should be very trivial.
@@ -6,8 +6,8 @@ An [ActionView::Resolver] implementation to store rails views (layouts, template
 ## Installation
 Add the following line to Gemfile:
 
-```
-gem "panoramic", "~> 0.0.3"
+```ruby
+gem "panoramic"
 ```
 
 ## Usage
@@ -18,7 +18,7 @@ Your model should have the following fields:
 * body (text): the source of template
 * path (string): where to find template (ex: layouts/application,
   you_controller/action, etc...)
-* locale (string): it depends from avaiable locales in your app
+* locale (string): it depends from available locales in your app
 * handler (string): as locale field, it depends from avaiable handlers
   (erb, haml, etc...)
 * partial (boolean): determines if it's a partial or not (false by
@@ -30,7 +30,7 @@ they're what the rails' Resolver API needs to lookup templates.
 ### Model
 A simple macro in model will activate your new Resolver. You can use a dedicated model to manage all the views in your app, or just for specific needs (ex: you want a custom template for some static pages, the other views will be fetched from filesystem).
 
-```
+```ruby
 class TemplateStorage < ActiveRecord::Base
   store_templates
 end
@@ -45,7 +45,7 @@ To add Panoramic::Resolver in controller, depending on your needs, you may choos
 **NOTE**: the above methods are both class and instance methods.
 
 
-```
+```ruby
 class SomeController < ApplicationController
   prepend_view_path TemplateStorage.resolver
 
@@ -65,6 +65,25 @@ class SomeController < ApplicationController
 end
 ```
 
+And let's say you want to use database template resolving in all your controllers, but
+want to use panoramic only for certain paths (prefixed with X) you can use
+
+```ruby
+class ApplicationController < ActionController::Base
+  prepend_view_path TemplateStorage.resolver(:only => 'use_this_prefix_only')
+end
+```
+
+This helps reducing the number of database requests, if Rails for example tries to look
+for layouts per controller.
+
+### ActionMailer
+
+```ruby
+class MyEmail < ActionMailer::Base
+  prepend_view_path TemplateStorage.resolver
+```
+
 ## Documentation
 Need more help? Check out ```spec/dummy/```, you'll find a *dummy* rails app I used to make tests ;-)
 
@@ -73,9 +92,7 @@ Enter Panoramic gem path, run ```bundle install``` to install development and te
 
 
 ## Todo
-### Short term
-* make orm specs DRY to reuse them with different orms
-* add, at least, Mongoid and DataMapper bindings
+
 ### Long term
 * add generators
 

data/Rakefile

@@ -13,4 +13,21 @@ require 'rspec/core/rake_task'
 Bundler::GemHelper.install_tasks
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+ORMS = %w(active_record)
+
+task :default => "spec:all"
+
+namespace :spec do
+  ORMS.each do |orm|
+    desc "Run Tests against #{orm}"
+    task orm do
+      sh "BUNDLE_GEMFILE='gemfiles/#{orm}.gemfile' bundle --quiet"
+      sh "BUNDLE_GEMFILE='gemfiles/#{orm}.gemfile' bundle exec rake -t spec"
+    end
+  end
+
+  desc "Run Tests against all ORMs"
+  task :all do
+    ORMS.each { |orm| Rake::Task["spec:#{orm}"].invoke }
+  end
+end

data/gemfiles/active_record.gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'activerecord', '>= 3.2.8', :require => 'active_record'
+
+gemspec :path => '../'

data/lib/panoramic/orm/active_record.rb

@@ -6,7 +6,7 @@ module Panoramic
           validates :body,    :presence => true
           validates :path,    :presence => true
           validates :format,  :inclusion => Mime::SET.symbols.map(&:to_s)
-          validates :locale,  :inclusion => I18n.available_locales.map(&:to_s)
+          validates :locale,  :inclusion => I18n.available_locales.map(&:to_s), :allow_blank => true
           validates :handler, :inclusion => ActionView::Template::Handlers.extensions.map(&:to_s)
 
           after_save { Panoramic::Resolver.instance.clear_cache }
@@ -20,8 +20,8 @@ module Panoramic
           self.where(conditions)
         end
 
-        def resolver
-          Panoramic::Resolver.using self
+        def resolver(options={})
+          Panoramic::Resolver.using self, options
         end
       end
     end

data/lib/panoramic/resolver.rb

@@ -4,11 +4,13 @@ module Panoramic
     include Singleton
 
     # this method is mandatory to implement a Resolver
-    def find_templates(name, prefix, partial, details)
+    def find_templates(name, prefix, partial, details, key=nil, locals=[])
+      return [] if @@resolver_options[:only] && !@@resolver_options[:only].include?(prefix)
+
       conditions = {
         :path    => build_path(name, prefix),
-        :locale  => normalize_array(details[:locale]).first,
-        :format  => normalize_array(details[:formats]).first,
+        :locale  => [normalize_array(details[:locale]).first, nil],
+        :format  => normalize_array(details[:formats]),
         :handler => normalize_array(details[:handlers]),
         :partial => partial || false
       }
@@ -19,8 +21,9 @@ module Panoramic
     end
 
     # Instantiate Resolver by passing a model (decoupled from ORMs)
-    def self.using(model)
+    def self.using(model, options={})
       @@model = model
+      @@resolver_options = options
       self.instance
     end
 
@@ -50,7 +53,7 @@ module Panoramic
     def normalize_array(array)
       array.map(&:to_s)
     end
-    
+
     # returns a path depending if its a partial or template
     def virtual_path(path, partial)
       return path unless partial