snippr 0.3.0 → 0.13.1

data/.gitignore

@@ -0,0 +1,13 @@
+.bundle
+.DS_Store
+nbproject
+pkg
+doc
+coverage
+.loadpath
+.project
+*~
+*.gem
+spec/reports
+Gemfile.lock
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in snippr.gemspec
+gemspec

data/README.md

@@ -0,0 +1,143 @@
+# Snippr
+## File based content management
+
+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.
+
+## Snippr path
+
+You need to specify the path to the directory where your Snippr files are stored:
+
+    Snippr.path = File.join File.dirname(__FILE__), "..", "snippr"
+
+When running on JRuby, you can also set the path via JVM properties. The property you need to
+specify is defined in Snippr::Path::JVMProperty. This allows system administrators to change the
+path without having to touch your application.
+
+## Loading a snippr
+
+To load a snippr file, you can use the +load+ method, passing in the path to the snippr file as
+a String (including path separators):
+
+    Snippr.load "tariff/einheit"
+
+or by using multiple Strings or Symbols:
+
+    Snippr.load :tariff, :einheit
+
+### Dynamic values
+
+A snippr file may contain placeholders to be replaced with dynamic values. Placeholders are
+wrapped in curly braces.
+
+    <p>You're topup of {topup_amount} at {date_today} was successful.</p>
+
+To replace both {topup_amount} and {date_today} with a dynamic value, you just pass in a Hash of
+placeholders and dynamic values when loading a snippr file.
+
+    Snippr.load :topup, :success, :topup_amount => number_to_currency(15), :date_today => Date.today
+
+The result will obviously be something like:
+
+    <p>You're topup of 15,00 &euro; at 2010-04-03 was successful.</p>
+
+### calling methods on passed variables
+
+You can call methods on passed parameters. Calling this:
+
+    class Klazz
+      def doit; "HELLO"; end
+    end
+    Snippr.load :snip :a_variable => Klass.new
+
+on ...
+
+    <p>Snippr says: {a_variable.doit}</p>
+
+will yield:
+  
+    <p>Snippr says: HELLO</p>
+
+You can even pass parameters to the call. Those *must* be enclosed in quotes ("):
+
+    class Klazz
+      def doitagain(p); "HELLO #{p}"; end
+    end
+    Snippr.load :snip :a_variable => Klass.new
+
+on ...
+
+    <p>Snippr says: {a_variable.doitagain("SNIPPR")}</p>
+
+will yield:
+  
+    <p>Snippr says: HELLO SNIPPR</p>
+
+### Meta Infos
+
+A snippet can not only hold content but also meta infos for this snippet.
+
+Inspired by [jekyll](http://jekyllrb.com) a snippet can host metdata that are accessable via the `.meta` method on a loaded snippet.
+`.meta' will return an empty hash when no data was found.
+
+Metadata must be placed at the top of the snippet and is delimited with three dashed.
+The data itself is parsed as YAML:
+
+    ---  
+    a_yaml: hash  
+    ---  
+    normal snippet content comes here until the end of the file
+
+### Including snippr files inside other files
+
+A snippr file can include another snippr file:
+
+    This snippr file includes another {snip:filepath/of/snip} file
+
+This will cause `filepath/of/snip.snip` to be included in place.
+
+Dynamic values of the parent snip will be accessable inside the included snip file.
+
+You can pass additional dynamic values when using `{snip}`. These will override any parent parameter.
+
+    {snip:filepath/of/snip,dyn_key1=dyn_value,dyn_key2=dyn_value2}
+
+Those will be available as {dyn_key1} and {dyn_key2} in filepath/of/snip.snip
+
+## I18n
+
+Snippr comes with support for I18n, but up until further notice, you have to manually enable this
+behavior in your application.
+
+    Snippr.i18n = true
+
+Afterwards Snippr uses the locale specified via I18n and automatically prepends the current locale
+prefixed with a "_" to your snippr files.
+
+    I18n.locale = :de
+    Snippr.load :shop # tries to load "shop_de.snip" relative to your Snippr path
+
+    I18n.locale = :en
+    Snippr.load :shop # tries to load "shop_en.snip" relative to your Snippr path
+  
+## Wiki Syntax
+
+Until now, only wiki links with text are supported by Snippr:
+
+    [[http://www.blaulabs.de|blaulabs]]
+  
+will be converted to:
+
+    <a href="http://www.blaulabs.de">blaulabs</a>
+
+## Rails Helper
+
+When using the Snippr module with Rails, it automatically adds the +Snippr::Helper+ module to
+your views. You can then use the +snippr+ helper method to load snippr files.
+
+    %h1 Topup successful
+    .topup.info
+      = snippr :topup, :success
+
+## Build Status
+![Travis-CI](https://secure.travis-ci.org/blaulabs/snippr.png)

data/Rakefile

@@ -1,9 +1,10 @@
+require "rubygems"
 require "rake"
-require "spec/rake/spectask"
 
-task :default => :spec
-
-Spec::Rake::SpecTask.new
+require 'rspec/core/rake_task'
+require 'ci/reporter/rake/rspec'
+RSpec::Core::RakeTask.new :spec
+task :default => %w(ci:setup:rspec spec)
 
 begin
   require "hanna/rdoctask"

data/lib/snippr.rb

@@ -1,2 +1,14 @@
-require "snippr/snippr"
-require "snippr/helper"
+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}
+
+Snippr::Normalizer.normalizers << Snippr::Normalizer::Camelizer.new
+# don't use DeRester this for all apps, but configure it as needed
+# Snippr::Normalizer.normalizers << Snippr::Normalizer::DeRester.new
+
+Snippr::Processor.processors << Snippr::Processor::Functions.new
+Snippr::Processor.processors << Snippr::Processor::Dynamics.new
+Snippr::Processor.processors << Snippr::Processor::Links.new
+Snippr::Processor.processors << Snippr::Processor::Wikilinks.new

data/lib/snippr/i18n.rb

@@ -2,25 +2,24 @@ require "i18n"
 
 # = Snippr::I18n
 #
-# Extends the Snippr module adding support for I18n snippr files.
+# Provides support for I18n snippr files.
 module Snippr
   module I18n
 
-    # Sets whether to use I18n snippr files.
-    def i18n=(enabled)
-      @enabled = enabled
+    # Returns whether to use I18n snippr files.
+    def self.enabled?
+      !!@@enabled
     end
 
-    # Returns whether to use I18n snippr files.
-    def i18n?
-      !!@enabled
+    # Sets whether to use I18n snippr files.
+    def self.enabled=(enabled)
+      @@enabled = enabled
     end
 
     # Returns the current locale prefixed with a "_" from I18n if I18n is enabled.
     # Otherwise defaults to an empty String.
-    def locale
-      return "" unless i18n?
-      ["_", ::I18n.locale].join
+    def self.locale(enabled=nil)
+      (enabled.nil? ? enabled? : enabled) ? "_#{::I18n.locale}" : ''
     end
 
   end

data/lib/snippr/links.rb

@@ -0,0 +1,59 @@
+# = Snippr::LinkHelper
+#
+# This module can be included to get functionality to adjust links.
+module Snippr
+  module Links
+
+    HREF_REGEX = /(href *= *['"])([^'"]*)(['"])/i
+
+    # Returns the regular expressions used to determine which urls to exclude from adjustment.
+    def self.adjust_urls_except
+      @@adjust_urls_except ||= [/^#/, /^[a-z]+:/i]
+    end
+
+    # Sets the regular expressions used to determine which urls to exclude from adjustment.
+    def self.adjust_urls_except=(adjust_urls_except)
+      @@adjust_urls_except = adjust_urls_except
+    end
+
+    # Adjusts a complete anchor tag, allowing the custom protocol popup: which will be converted to a javascript call to popup(this).
+    def self.adjust_link(link)
+      return link if link !~ HREF_REGEX
+      url = $2
+      if url =~ /popup:\/*(.*)$/i
+        url = adjust_url $1
+        onclick = "onclick=\"if (typeof popup == 'undefined') { return true; } else { popup(this); return false; }\""
+        # replace an existing onclick (if present)
+        link_with_onclick = link.gsub /onclick *= *['"][^'"]*['"]/i, onclick
+        # add a new onclick (when there was no existing onclick)
+        link_with_onclick = link.gsub /(^[^>]+)>/, "\\1 #{onclick}>" if link_with_onclick == link
+        link = link_with_onclick
+      else
+        url = adjust_url url
+      end
+      link.gsub HREF_REGEX, "\\1#{url}\\3"
+    end
+
+    # Adjusts an url, prepending / and relative url root (context path) as needed.
+    def self.adjust_url(url)
+      adjust_urls_except.each do |regex|
+        return url if url =~ regex
+      end
+      root = relative_url_root
+      url.gsub(/^(#{root}|\/)?/, root)
+    end
+
+    # Returns the relative url root (context path) the application is deployed to.
+    def self.relative_url_root
+      if defined? ActionController::Base
+        root = ActionController::Base.config.relative_url_root || '/'
+        root = "/#{root}" unless root.start_with?('/')
+        root << '/' unless root.end_with?('/')
+        root
+      else
+        '/'
+      end
+    end
+
+  end
+end

data/lib/snippr/meta_data.rb

@@ -0,0 +1,33 @@
+# -*- encoding : utf-8 -*-
+require "yaml"
+
+# = Snippr::MetaData
+#
+# Handles Snippr's YAML Front Matter inspired by Jekyll.
+# Useful for passing meta information about a Snip to the app.
+module Snippr
+
+  class MetaData
+
+    def self.extract(name, content)
+      if content =~ /^(---\s*\n.*?\n?)^(---\s*$?)/m
+        content = Regexp.last_match.post_match.strip
+        meta = yaml_load(name, $1)
+      end
+
+      meta = meta ? meta : {}
+      [content, meta]
+    end
+
+  private
+
+    def self.yaml_load(name, yml)
+      YAML.load(yml)
+    rescue Exception => e
+      Snippr.logger.warn "Unable to extract meta data from Snip #{name.inspect}: #{e.message}"
+      {}
+    end
+
+  end
+
+end

data/lib/snippr/normalizer.rb

@@ -0,0 +1,18 @@
+# = Snippr::Normalizer
+#
+# Provides methods to normalize snippr path elements.
+module Snippr
+  module Normalizer
+
+    # Returns a (modifiable) list of normalizers that'll be used to normalize a path element.
+    def self.normalizers
+      @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}
+    end
+
+  end
+end

data/lib/snippr/normalizer/camelizer.rb

@@ -0,0 +1,18 @@
+# = Snippr::Normalizer::Camelizer
+#
+# When given a symbol, normalizes it to a lower camelized string, otherwise just returns the given string.
+module Snippr
+
+  module Normalizer
+
+    class Camelizer
+
+      def normalize(path_element)
+        path_element.kind_of?(Symbol) ? path_element.to_s.camelize(:lower) : path_element
+      end
+
+    end
+
+  end
+
+end

data/lib/snippr/normalizer/de_rester.rb

@@ -0,0 +1,25 @@
+# = Snippr::Normalizer::DeRester
+#
+# "Redirects" REST path elements that are accessed via POST (create, update destroy) with
+# their corresponding GET elements (new, edit, show) so that when eg create is rendered due
+# to an error in the action, it just looks exactly like the new page it was issued from.
+module Snippr
+
+  module Normalizer
+
+    class DeRester
+
+      def normalize(path_element)
+        case path_element.to_s
+        when "create" then "new"
+        when "update" then "edit"
+        when "destroy" then "show"
+        else path_element.to_s
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/snippr/path.rb

@@ -1,25 +1,46 @@
 # = Snippr::Path
 #
-# Extends the Snippr module with methods dealing the path to the snippr files.
+# 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.
-    JVMProperty = "cms.snippet.path"
+    JVM_PROPERTY = 'cms.snippet.path'
 
     # Returns the path to the snippr files (from JVM properties if available).
-    def path
-      @path ||= JavaLang::System.get_property(JVMProperty) rescue ""
+    def self.path
+      @@path ||= JavaLang::System.get_property(JVM_PROPERTY) rescue ""
     end
 
     # Sets the path to the snippr files.
-    def path=(path)
-      @path = path.to_s
+    def self.path=(path)
+      @@path = path.to_s
+    end
+
+    # Builds a snippr name from an array of path parts.
+    def self.normalize_name(*names)
+      names.map do |name|
+        Normalizer.normalize(name)
+      end.join("/")
+    end
+
+    # Builds a snippr path (inside the configured path) from a name and an optional extension.
+    def self.path_from_name(name, ext = nil)
+      File.join(path, (ext ? "#{name}.#{ext}" : name))
+    end
+
+    # Lists all snips inside a snippr directory specified by path parts.
+    def self.list(*names)
+      dir = path_from_name normalize_name *names
+      Dir["#{dir}/*#{I18n.locale}.#{Snip::FILE_EXTENSION}"].map do |snip|
+        snip.gsub(/^.*\/([^\.]+)?\.#{Snip::FILE_EXTENSION}$/, '\1').gsub(/_.*$/, '').underscore
+      end.sort.map(&:to_sym)
     end
 
   private
 
     if RUBY_PLATFORM =~ /java/
+      require 'java'
       module JavaLang
         include_package "java.lang"
       end