hogan_assets 1.4.0 → 1.5.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.5.0 (2013-2-06)
+
+* YAML configuration support - @apai4
+
 ## 1.4.0 (2013-1-02)
 
 * **slimstache** support, use `HoganAssets::Config.slim_options` to set options for `slim` - @sars

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hogan_assets (1.4.0)
+    hogan_assets (1.5.0)
       execjs (>= 1.2.9)
       sprockets (>= 2.0.3)
       tilt (>= 1.3.3)
@@ -9,6 +9,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    columnize (0.3.6)
+    debugger (1.3.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.7)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.7)
     execjs (1.4.0)
       multi_json (~> 1.0)
     haml (3.1.6)
@@ -30,6 +38,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  debugger
   haml
   hogan_assets!
   slim

data/README.md

@@ -69,6 +69,8 @@ _slimstache_ is the also popular combination of `slim` and `mustache`. Works jus
 
 ## Configuration
 
+You can configure options using either an intializer or with a YAML file (`config/hogan_assets.yml`). See `lib/hogan_assets/config.rb` for details.
+
 ### Lambda Support
 
 **mustache** lambdas are off by default. (Not sure what that is? Read the [mustache](http://mustache.github.com/mustache.5.html) man page!) If you want them on, set the `lambda_support` option to true. This will include the raw template text as part of the compiled template; each template will be correspondingly larger. *TODO* Should this be on by default?
@@ -113,6 +115,7 @@ By default, templates are recognized if they have an extension of `.mustache` (a
       config.template_extensions = %w(mustache hamstache stache)
     end
 
+
 ## Usage
 
 Templates are compiled to a global JavaScript object named `HoganTemplates`. To render `pages/person`:
@@ -133,6 +136,7 @@ I made this because I <3 **mustache** and want to use it in Rails. Follow me on
 * @adamstrickland (Adam Strickland) : Custom template namespace
 * @lautis         (Ville Lautanala) : haml_options configuration
 * @sars           (Rodion)          : slimstache support
+* @apai4                            : YAML configuration
 
 ## Contributing
 

data/hogan_assets.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "tilt", ">= 1.3.3"
   gem.add_runtime_dependency "sprockets", ">= 2.0.3"
 
+  gem.add_development_dependency "debugger"
   gem.add_development_dependency "haml"
   gem.add_development_dependency "slim"
 end

data/lib/hogan_assets.rb

@@ -4,13 +4,14 @@ require 'hogan_assets/config'
 module HoganAssets
   extend Config
 
-  autoload(:Hogan, 'hogan_assets/hogan')
-  autoload(:Tilt, 'hogan_assets/tilt')
+  autoload :Hogan, 'hogan_assets/hogan'
+  autoload :Tilt, 'hogan_assets/tilt'
 
-  if defined?(Rails)
+  if defined? Rails
     require 'hogan_assets/engine'
   else
     require 'sprockets'
+    Config.load_yml! if Config.yml_exists?
     Config.template_extensions.each do |ext|
       Sprockets.register_engine ".#{ext}", Tilt
     end

data/lib/hogan_assets/config.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module HoganAssets
   # Change config options in an initializer:
   #
@@ -13,31 +15,80 @@ module HoganAssets
   #   config.slim_options[:pretty] = false
   # end
   #
+  # Or change config options in a YAML file (config/hogan_assets.yml):
+  #
+  # defaults: &defaults
+  #   lambda_support: false
+  #   path_prefix: 'templates'
+  #   template_extensions:
+  #     - 'hamstache'
+  #     - 'slimstache'
+  #   template_namespace: 'JST'
+  #   haml_options:
+  #     ugly: true
+  #   slim_options:
+  #     pretty: false
+  # development:
+  #   <<: *defaults
+  # test:
+  #   <<: *defaults
+  # production:
+  #   <<: *defaults
+  #
   module Config
     extend self
 
-    attr_writer :lambda_support, :path_prefix, :template_extensions, :template_namespace, :haml_options, :slim_options
+    attr_writer :env, :lambda_support, :path_prefix, :template_extensions, :template_namespace, :haml_options, :slim_options
 
     def configure
       yield self
     end
 
+    def env
+      @env ||= if defined? Rails
+                 Rails.env
+               elsif ENV['RACK_ENV']
+                 ENV['RACK_ENV']
+               else
+                 'development'
+               end
+    end
+
     def haml_available?
       defined? ::Haml::Engine
     end
 
-    def slim_available?
-      defined? ::Slim::Engine
+    def haml_options
+      @haml_options ||= {}
     end
 
     def lambda_support?
       @lambda_support
     end
 
+    def load_yml!
+      @lambda_support      = yml['lambda_support'] if yml.has_key? 'lambda_support'
+      @path_prefix         = yml['path_prefix'] if yml.has_key? 'path_prefix'
+      @template_extensions = yml['template_extensions'] if yml.has_key? 'template_extensions'
+      @template_namespace  = yml['template_namespace'] if yml.has_key? 'template_namespace'
+      @haml_options        = yml['haml_options'] if yml.has_key? 'haml_options'
+      @slim_options        = yml['slim_options'] if yml.has_key? 'slim_options'
+      symbolize(@haml_options) if @haml_options
+      symbolize(@slim_options) if @slim_options
+    end
+
     def path_prefix
       @path_prefix ||= 'templates'
     end
 
+    def slim_available?
+      defined? ::Slim::Engine
+    end
+
+    def slim_options
+      @slim_options ||= {}
+    end
+
     def template_namespace
       @template_namespace ||= 'HoganTemplates'
     end
@@ -46,12 +97,32 @@ module HoganAssets
       @template_extensions ||= "mustache#{' hamstache' if haml_available?}#{' slimstache' if slim_available?}".split
     end
 
-    def haml_options
-      @haml_options ||= {}
+    def yml
+      begin
+        @yml ||= (YAML.load(IO.read yml_path)[env] rescue nil) || {}
+      rescue Psych::SyntaxError
+        @yml = {}
+      end
     end
 
-    def slim_options
-      @slim_options ||= {}
+    def yml_exists?
+      File.exists? yml_path
+    end
+
+    private
+
+    def symbolize(hash)
+      hash.keys.each do |key|
+        hash[(key.to_sym rescue key) || key] = hash.delete(key)
+      end
+    end
+
+    def yml_path
+      @yml_path ||= if defined? Rails
+                      Rails.root.join 'config', 'hogan_assets.yml'
+                    else
+                      Pathname.new('.') + 'config/hogan_assets.yml'
+                    end
     end
   end
 end

data/lib/hogan_assets/engine.rb

@@ -2,6 +2,7 @@ module HoganAssets
   class Engine < ::Rails::Engine
     initializer "sprockets.hogan", :after => "sprockets.environment", :group => :all do |app|
       next unless app.assets
+      HoganAssets::Config.load_yml! if HoganAssets::Config.yml_exists?
       HoganAssets::Config.template_extensions.each do |ext|
         app.assets.register_engine(".#{ext}", Tilt)
       end

data/lib/hogan_assets/version.rb

@@ -1,3 +1,3 @@
 module HoganAssets
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/test/config/hogan_assets.yml

@@ -0,0 +1,5 @@
+test:
+  template_extensions:
+    - 'custom'
+  haml_options:
+    ugly: true

data/test/hogan_assets/config_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+module HoganAssets
+  module Config
+    extend self
+
+    def yml_path=(yml_path)
+      @yml_path = yml_path
+    end
+  end
+
+  class ConfigTest < Test::Unit::TestCase
+    include TestSupport
+
+    def setup
+      HoganAssets::Config.env = 'test'
+      HoganAssets::Config.yml_path = Pathname.new('.') + 'test/config/hogan_assets.yml'
+      HoganAssets::Config.load_yml!
+    end
+
+    def teardown
+      HoganAssets::Config.env = nil
+      HoganAssets::Config.haml_options = nil
+      HoganAssets::Config.template_extensions = nil
+      HoganAssets::Config.yml_path = nil
+    end
+
+    def test_yaml_options
+      scope = make_scope '/myapp/app/assets/javascripts', 'path/to/template.custom'
+      template = HoganAssets::Tilt.new(scope.s_path) { "This is {{mustache}}" }
+      assert_match /This is/, template.render(scope, {})
+      assert_equal HoganAssets::Config.haml_options, ugly: true
+    end
+  end
+end

data/test/hogan_assets/tilt_test.rb

@@ -2,18 +2,7 @@ require 'test_helper'
 
 module HoganAssets
   class TiltTest < Test::Unit::TestCase
-   # Try to act like sprockets.
-    def make_scope(root, file)
-      Class.new do
-        define_method(:logical_path) { pathname.to_s.gsub(root + '/', '').gsub(/\..*/, '') }
-
-        define_method(:pathname) { Pathname.new(root) + file }
-
-        define_method(:root_path) { root }
-
-        define_method(:s_path) { pathname.to_s }
-      end.new
-    end
+    include TestSupport
 
     def teardown
       HoganAssets::Config.lambda_support = false

data/test/test_helper.rb

@@ -1,5 +1,18 @@
-require 'hogan_assets/tilt'
-require 'hogan_assets/hogan'
-require 'hogan_assets/config'
+require 'hogan_assets'
 
 require 'test/unit'
+
+module TestSupport
+  # Try to act like sprockets.
+  def make_scope(root, file)
+    Class.new do
+      define_method(:logical_path) { pathname.to_s.gsub(root + '/', '').gsub(/\..*/, '') }
+
+      define_method(:pathname) { Pathname.new(root) + file }
+
+      define_method(:root_path) { root }
+
+      define_method(:s_path) { pathname.to_s }
+    end.new
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hogan_assets
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,88 +9,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.9
-    none: false
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.9
-    none: false
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.3
-    none: false
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.3
-    none: false
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.3
-    none: false
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
     none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: Use compiled hogan.js (mustache) JavaScript templates with sprockets
   and the Rails asset pipeline.
 email:
@@ -114,6 +130,8 @@ files:
 - lib/hogan_assets/hogan.rb
 - lib/hogan_assets/tilt.rb
 - lib/hogan_assets/version.rb
+- test/config/hogan_assets.yml
+- test/hogan_assets/config_test.rb
 - test/hogan_assets/tilt_test.rb
 - test/test_helper.rb
 - vendor/assets/javascripts/hogan.js
@@ -124,24 +142,26 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Use compiled hogan.js (mustache) JavaScript templates with sprockets and
   the Rails asset pipeline.
 test_files:
+- test/config/hogan_assets.yml
+- test/hogan_assets/config_test.rb
 - test/hogan_assets/tilt_test.rb
 - test/test_helper.rb