snippr 0.13.1 → 0.13.2

data/README.md

@@ -1,5 +1,6 @@
 # Snippr
 ## File based content management
+![Travis-CI](https://secure.travis-ci.org/blaulabs/snippr.png)
 
 A snippr file is a piece of HTML or raw text to be included in a website. They are plain text
 files stored on the file system. Snippr files end with ".snip" and are read from the Snippr path.
@@ -139,5 +140,16 @@ your views. You can then use the +snippr+ helper method to load snippr files.
     .topup.info
       = snippr :topup, :success
 
-## Build Status
-![Travis-CI](https://secure.travis-ci.org/blaulabs/snippr.png)
+## Configuration via railtie
+Starting in version 0.13.2 you can configure snippr without the use of initializers when using Rails:
+
+Edit `application.rb` (or the environment specific files in config/environments) and add:
+
+    class Application < Rails::Application
+      config.snippr.i18n = true
+      # Add a Normalizer:
+      config.snippr.normalizers = Snippr::Normalizer::DeRester.new
+      config.snippr.path = "my/path/to/snippets"
+      # or even for defered configuration with a lambda:
+      # config.snippr.path = lambda { SomeClassThatsAvailableLater.path }
+    end

data/lib/snippr/normalizer.rb

@@ -1,3 +1,4 @@
+# # -*- encoding : utf-8 -*-
 # = Snippr::Normalizer
 #
 # Provides methods to normalize snippr path elements.
@@ -9,6 +10,10 @@ module Snippr
       @normalizers ||= []
     end
 
+    def self.add(normalizer_or_normalizers)
+      @normalizers = Array(@normalizers) + Array(normalizer_or_normalizers)
+    end
+
     # Sends the given path element to all the configured normalizers and returns the result.
     def self.normalize(path_element)
       @normalizers.inject(path_element) {|e, normalizer| normalizer.normalize e}

data/lib/snippr/path.rb

@@ -1,20 +1,22 @@
+# # -*- encoding : utf-8 -*-
 # = Snippr::Path
 #
 # Provides methods for dealing with the path to snippr files.
 module Snippr
   module Path
 
-    # The JVM property to set the path to the snippr files.
-    JVM_PROPERTY = 'cms.snippet.path'
-
-    # Returns the path to the snippr files (from JVM properties if available).
+    # Returns the path to the snippr files
     def self.path
-      @@path ||= JavaLang::System.get_property(JVM_PROPERTY) rescue ""
+      if @@path.respond_to?(:call)
+        @@path_evaled ||= @@path.call
+      else
+        @@path.to_s
+      end
     end
 
     # Sets the path to the snippr files.
     def self.path=(path)
-      @@path = path.to_s
+      @@path = path
     end
 
     # Builds a snippr name from an array of path parts.
@@ -37,14 +39,5 @@ module Snippr
       end.sort.map(&:to_sym)
     end
 
-  private
-
-    if RUBY_PLATFORM =~ /java/
-      require 'java'
-      module JavaLang
-        include_package "java.lang"
-      end
-    end
-
   end
 end

data/lib/snippr/railtie.rb

@@ -0,0 +1,15 @@
+# -*- encoding : utf-8 -*-
+module Snippr
+
+  class Railtie < Rails::Railtie
+
+    config.snippr = ActiveSupport::OrderedOptions.new
+
+    initializer :setup_snippr, :group => :all do |app|
+      Snippr.i18n = app.config.snippr.i18n
+      Snippr.path = app.config.snippr.path
+      Snippr::Normalizer.add app.config.snippr.normalizers if app.config.snippr.normalizers
+    end
+
+  end
+end

data/lib/snippr/snip.rb

@@ -2,11 +2,10 @@
 # = Snippr::Snip
 #
 # Represents a single snip and provides methods to read data.
+
 module Snippr
   class Snip
 
-    extend ActiveSupport::Memoizable
-
     FILE_EXTENSION = 'snip'
 
     def initialize(*names)
@@ -22,20 +21,20 @@ module Snippr
 
     # Returns the processed and decorated content.
     def content
-      if missing?
-        "<!-- missing snippr: #{name} -->"
-      else
-        content = Processor.process unprocessed_content, opts
-        "<!-- starting snippr: #{name} -->\n#{content}\n<!-- closing snippr: #{name} -->"
+      @content ||= begin
+        if missing?
+          "<!-- missing snippr: #{name} -->"
+        else
+          content = Processor.process unprocessed_content, opts
+          "<!-- starting snippr: #{name} -->\n#{content}\n<!-- closing snippr: #{name} -->"
+        end
       end
     end
-    memoize :content
     alias :to_s :content
 
     def raw_content
-      missing? ? '' : File.read(@path).strip
+      @raw_content ||= missing? ? '' : File.read(@path).strip
     end
-    memoize :raw_content
 
     # Returns whether the snip is missing or not.
     def missing?

data/lib/snippr.rb

@@ -1,8 +1,24 @@
+# -*- encoding : utf-8 -*-
 require 'active_support/core_ext'
 
-Dir[File.expand_path '../snippr/*.rb', __FILE__].each {|f| require f}
-Dir[File.expand_path '../snippr/normalizer/*.rb', __FILE__].each {|f| require f}
-Dir[File.expand_path '../snippr/processor/*.rb', __FILE__].each {|f| require f}
+require 'snippr/snippr'
+require 'snippr/snip'
+require 'snippr/i18n'
+require 'snippr/links'
+require 'snippr/meta_data'
+require 'snippr/normalizer'
+require 'snippr/path'
+require 'snippr/processor'
+require 'snippr/railtie' if defined?(Rails)
+require 'snippr/view_helper'
+
+require 'snippr/normalizer/camelizer'
+require 'snippr/normalizer/de_rester'
+
+require 'snippr/processor/dynamics'
+require 'snippr/processor/functions'
+require 'snippr/processor/links'
+require 'snippr/processor/wikilinks'
 
 Snippr::Normalizer.normalizers << Snippr::Normalizer::Camelizer.new
 # don't use DeRester this for all apps, but configure it as needed

data/snippr.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "snippr"
-  s.version     = "0.13.1"
+  s.version     = "0.13.2"
   s.date        = Time.now
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Daniel Harrington", "Thomas Jachmann"]
@@ -16,12 +16,9 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "activesupport"
 
   s.add_development_dependency "ci_reporter", "~> 1.6.5"
-  s.add_development_dependency "rspec", "~> 2.6.0"
-  s.add_development_dependency "mocha", "0.9.12"
-  s.add_development_dependency "rake", "~> 0.9.0"
-  # pin down ZenTest so that autotest works without upgrading rubygems
-  # see http://stackoverflow.com/questions/6802610/autotest-problem [mw, 2011-08-10]
-  s.add_development_dependency "ZenTest", "4.5.0"
+  s.add_development_dependency "rspec", "~> 2.8.0"
+  s.add_development_dependency "mocha", "0.11.4"
+  s.add_development_dependency "rake", "~> 0.9.2"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/snippr/normalizer_spec.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require "spec_helper"
 
 describe Snippr::Normalizer do
@@ -37,4 +38,23 @@ describe Snippr::Normalizer do
 
   end
 
+  describe ".add" do
+
+    before do
+      subject.normalizers.clear
+      subject.normalizers << Snippr::Normalizer::Camelizer.new
+    end
+
+    it "adds the normalizer if an class" do
+      subject.add(Snippr::Normalizer::DeRester.new)
+      subject.normalizers.should have(2).normalizers
+    end
+
+    it "adds the normalizers if an array" do
+      subject.add([Snippr::Normalizer::DeRester.new, Snippr::Normalizer::DeRester.new])
+      subject.normalizers.should have(3).normalizers
+    end
+
+  end
+
 end

data/spec/snippr/path_spec.rb

@@ -1,23 +1,30 @@
+# -*- encoding : utf-8 -*-
 require "spec_helper"
 
 describe Snippr::Path do
 
   describe "path" do
 
-    it "should store the path" do
+    before do
       subject.path = nil
+    end
+
+    it "stores the path if set as string" do
       subject.path.should == ''
       subject.path = 'path'
       subject.path.should == 'path'
     end
 
-    # TODO test JVM path? [thomas, 2010-08-26]
+    it "stores and defers the path evaluation if passed a lambda" do
+      subject.path = lambda { "WOW LAMBDA ACTION!" }
+      subject.path.should == "WOW LAMBDA ACTION!"
+    end
 
   end
 
   describe ".normalize_name" do
 
-    it "should call Snippr::Normalizer.normalize with all names and return normalized result" do
+    it "calls Snippr::Normalizer.normalize with all names and return normalized result" do
       seq = sequence "normalizers"
       Snippr::Normalizer.expects(:normalize).with("a").in_sequence(seq).returns("AA")
       Snippr::Normalizer.expects(:normalize).with(:b).in_sequence(seq).returns("BB")
@@ -32,11 +39,11 @@ describe Snippr::Path do
       subject.path = 'path'
     end
 
-    it "should join path and name (with extension)" do
+    it "joins path and name (with extension)" do
       subject.path_from_name('name', 'snip').should == 'path/name.snip'
     end
 
-    it "should join path and name (without extension)" do
+    it "joins path and name (without extension)" do
       subject.path_from_name('file').should == 'path/file'
     end
 
@@ -50,11 +57,11 @@ describe Snippr::Path do
         Snippr::I18n.enabled = false
       end
 
-      it "should return a list of all snippr names" do
+      it "returns a list of all snippr names" do
         subject.list(:topup).should == [:some_error, :success]
       end
 
-      it "should return an empty array for non existant dirs" do
+      it "returns an empty array for non existant dirs" do
         subject.list(:doesnotexist).should == []
       end
 
@@ -66,17 +73,17 @@ describe Snippr::Path do
         Snippr::I18n.enabled = true
       end
 
-      it "should return a list of all snippr names of the current locale (de)" do
+      it "returns a list of all snippr names of the current locale (de)" do
         I18n.locale = :de
         subject.list(:i18n).should == [:list, :shop]
       end
 
-      it "should return a list of all snippr names of the current locale (en)" do
+      it "returns a list of all snippr names of the current locale (en)" do
         I18n.locale = :en
         subject.list(:i18n).should == [:shop]
       end
 
-      it "should return an empty array for non existant dirs" do
+      it "returns an empty array for non existant dirs" do
         subject.list(:doesnotexist).should == []
       end
 

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
+# -*- encoding : utf-8 -*-
 require 'rubygems'
 require 'bundler'
+require 'snippr'
+
 Bundler.require(:default, :development)
 
 RSpec.configure do |config|
@@ -8,11 +11,6 @@ RSpec.configure do |config|
     Snippr::I18n.enabled = nil
     Snippr::Links.adjust_urls_except = nil
     snippr_path = File.expand_path '../fixtures', __FILE__
-    if RUBY_PLATFORM =~ /java/
-      Snippr::Path.path = snippr_path
-      Snippr::Path::JavaLang::System.set_property Snippr::Path::JVM_PROPERTY, snippr_path
-    else
-      Snippr::Path.path = snippr_path
-    end
+    Snippr::Path.path = snippr_path
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snippr
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.13.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-15 00:00:00.000000000 Z
+date: 2012-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2181996100 !ruby/object:Gem::Requirement
+  requirement: &2183725920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2181996100
+  version_requirements: *2183725920
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2181995660 !ruby/object:Gem::Requirement
+  requirement: &2183725480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2181995660
+  version_requirements: *2183725480
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2181995160 !ruby/object:Gem::Requirement
+  requirement: &2183774080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,51 +44,40 @@ dependencies:
         version: 1.6.5
   type: :development
   prerelease: false
-  version_requirements: *2181995160
+  version_requirements: *2183774080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2181994660 !ruby/object:Gem::Requirement
+  requirement: &2183773580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *2181994660
+  version_requirements: *2183773580
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2181994200 !ruby/object:Gem::Requirement
+  requirement: &2183773120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: 0.11.4
   type: :development
   prerelease: false
-  version_requirements: *2181994200
+  version_requirements: *2183773120
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2181993740 !ruby/object:Gem::Requirement
+  requirement: &2183772660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *2181993740
-- !ruby/object:Gem::Dependency
-  name: ZenTest
-  requirement: &2181993280 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
-        version: 4.5.0
-  type: :development
-  prerelease: false
-  version_requirements: *2181993280
+  version_requirements: *2183772660
 description: This gem provides ways to access file based cms resources from a rails
   app.
 email:
@@ -118,10 +107,10 @@ files:
 - lib/snippr/processor/functions.rb
 - lib/snippr/processor/links.rb
 - lib/snippr/processor/wikilinks.rb
+- lib/snippr/railtie.rb
 - lib/snippr/snip.rb
 - lib/snippr/snippr.rb
 - lib/snippr/view_helper.rb
-- rails/init.rb
 - snippr.gemspec
 - spec/fixtures/a/path/aSnippet.snip
 - spec/fixtures/a/path/aSnippetWithParam.snip

data/rails/init.rb

@@ -1 +0,0 @@
-require "snippr"