snippr 0.3.0 → 0.13.1

data/lib/snippr/processor.rb

@@ -0,0 +1,18 @@
+# = Snippr::Processor
+#
+# Provides methods to process snippr content.
+module Snippr
+  module Processor
+
+    # Returns a (modifiable) list of processors that'll be used to process the content.
+    def self.processors
+      @processors ||= []
+    end
+
+    # Sends the given content and opts to all the configured processors and returns the result.
+    def self.process(content, opts)
+      @processors.inject(content) {|c, processor| processor.process c, opts}
+    end
+
+  end
+end

data/lib/snippr/processor/dynamics.rb

@@ -0,0 +1,31 @@
+# = Snippr::Processor::Dynamics
+#
+# Replaces {placeholder} placeholders in the content with values taken from the given opts.
+module Snippr
+
+  module Processor
+
+    class Dynamics
+
+      def process(content, opts = {})
+        opts.inject(content) do |c, pv|
+          placeholder, value = pv
+          c.gsub(/\{#{placeholder}(?:\.(.*?)\(["]?(.*?)["]?\))?\}/m) do |match|
+            if $1 && value.respond_to?($1)
+              method = $1
+              params = ($2 || "").gsub(/[\t\r\n]/,"").split("\",\"")
+              value.send(method, *params).to_s
+            elsif $1
+              match
+            else
+              value.to_s
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/snippr/processor/functions.rb

@@ -0,0 +1,50 @@
+# = Snippr::Processor::Functions
+#
+# Processes several functions in {command:options} syntax.
+module Snippr
+
+  module Processor
+
+    class Functions
+
+      def process(content, opts = {})
+        content.scan(/\{(.*?):(.*?)\}/) do |match|
+          command, func_options = match
+          options = opts.merge(hashify(func_options))
+          command = "cmd_#{command}"
+          content = send(command, content, options, func_options) if respond_to?(command, true)
+        end
+        content
+      end
+
+    private
+
+      # expand another snip
+      # {snip:path/to/snippet}
+      def cmd_snip(unprocessed_content, opts, original_options)
+        path = opts[:default].split("/")
+        snip_content = Snippr::Snip.new(*path + [opts]).content
+        unprocessed_content.gsub("{snip:#{original_options}}", snip_content)
+      end
+
+      # home
+      # snip=home
+      # snip=home,var=1
+      def hashify(func_options="")
+        options = {}
+        func_options.split(",").each do |option|
+          opt_key, opt_value = option.split("=")
+          unless opt_value
+            opt_value = opt_key
+            opt_key = :default
+          end
+          options[opt_key.to_sym] = opt_value
+        end
+        options
+      end
+
+    end
+
+  end
+
+end

data/lib/snippr/processor/links.rb

@@ -0,0 +1,20 @@
+# = Snippr::Processor::Links
+#
+# Adjusts URLs in links.
+module Snippr
+
+  module Processor
+
+    class Links
+
+      def process(content, opts = {})
+        content.gsub /<a [^>]+>[^<]*<\/a>/i do |match|
+          Snippr::Links.adjust_link match
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/snippr/processor/wikilinks.rb

@@ -0,0 +1,20 @@
+# = Snippr::Processor::Wikilinks
+#
+# Replaces links in [url|title] syntax with real links.
+module Snippr
+
+  module Processor
+
+    class Wikilinks
+
+      def process(content, opts = {})
+        content.gsub /\[\[([^|]+)\|([^\]]+)\]\]/ do |match|
+          Snippr::Links.adjust_link "<a href=\"#{$1}\">#{$2}</a>"
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/snippr/snip.rb

@@ -0,0 +1,57 @@
+# # -*- encoding : utf-8 -*-
+# = 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)
+      names = strip_empty_values(names)
+      @opts = names.last.kind_of?(Hash) ? names.pop : {}
+      @opts.symbolize_keys!
+      @name = "#{Path.normalize_name(*names)}#{ I18n.locale(@opts[:i18n]) }"
+      @path = Path.path_from_name @name, (@opts[:extension] || FILE_EXTENSION)
+      @unprocessed_content, @meta = MetaData.extract(names, raw_content)
+    end
+
+    attr_reader :name, :path, :opts, :unprocessed_content, :meta
+
+    # 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} -->"
+      end
+    end
+    memoize :content
+    alias :to_s :content
+
+    def raw_content
+      missing? ? '' : File.read(@path).strip
+    end
+    memoize :raw_content
+
+    # Returns whether the snip is missing or not.
+    def missing?
+      !File.exist? @path
+    end
+
+    # Returns whether the snip is empty or not.
+    def empty?
+      unprocessed_content.blank?
+    end
+
+  private
+
+    def strip_empty_values(names)
+      names - [nil, ""]
+    end
+
+  end
+end

data/lib/snippr/snippr.rb

@@ -1,7 +1,4 @@
-require "snippr/core_ext"
-require "snippr/path"
-require "snippr/i18n"
-require "snippr/link"
+require "logger"
 
 # = Snippr
 # ==== File based content management
@@ -9,56 +6,55 @@ require "snippr/link"
 # 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.
 module Snippr
-  extend Snippr::Path
-  extend Snippr::I18n
-  extend Snippr::Link
+  extend self
 
-  class << self
-
-    # The snippr file extension.
-    FileExtension = ".snip"
-
-    # The comments wrapping a snippr.
-    SnipprComments = "<!-- starting snippr: %s -->\n%s\n<!-- closing snippr: %s -->"
+  # Returns the path to the snippr files (from JVM properties if available).
+  def path
+    Path.path
+  end
 
-    # The fallback tag for a missing snippr.
-    MissingSnipprTag = '<samp class="missing snippr" />'
+  # Sets the path to the snippr files.
+  def path=(path)
+    Path.path = path
+  end
 
+  # Returns whether to use I18n snippr files.
+  def i18n?
+    I18n.enabled?
+  end
 
-    # Expects the name of a snippr file. Also accepts a Hash of placeholders
-    # to be replaced with dynamic values.
-    def load(*args)
-      @dynamics = args.last.kind_of?(Hash) ? args.pop : {}
-      @name = name_from args
-      SnipprComments % [@name, content, @name]
-    end
+  # Sets whether to use I18n snippr files.
+  def i18n=(enabled)
+    I18n.enabled = enabled
+  end
 
-  private
+  # Returns the regular expressions used to determine which urls to exclude from adjustment.
+  def adjust_urls_except
+    Links.adjust_urls_except
+  end
 
-    # Returns the name of a snippr from a given Array of +args+.
-    def name_from(args)
-      args.map { |arg| arg.kind_of?(Symbol) ? arg.to_s.lower_camelcase : arg }.join("/") + locale
-    end
+  # Sets the regular expressions used to determine which urls to exclude from adjustment.
+  def adjust_urls_except=(adjust_urls_except)
+    Links.adjust_urls_except = adjust_urls_except
+  end
 
-    # Returns the raw snippr content or a +MissingSnipprTag+ in case the snippr
-    # file does not seem to exist.
-    def content
-      return MissingSnipprTag unless File.exist? file
-      
-      content = File.read(file).strip
-      insert_dynamics content
-      linkify content
-    end
+  # Sets the logger to use.
+  attr_writer :logger
 
-    # Returns the complete path to a snippr file.
-    def file
-      File.join path, [@name, FileExtension].join
-    end
+  # Returns the logger. Uses the Rails logger when available or falls back to a custom logger.
+  def logger
+    @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+  end
 
-    # Replaces placeholders found in a given snippr +content+ with dynamic values.
-    def insert_dynamics(content)
-      @dynamics.each { |placeholder, value| content.gsub! "{#{placeholder}}", value.to_s }
-    end
+  # Expects the name of a snippr file. Also accepts a Hash of placeholders
+  # to be replaced with dynamic values.
+  def load(*args)
+    Snip.new(*args)
+  end
 
+  # Lists all snips inside a snippr directory specified by path parts.
+  def list(*args)
+    Path.list *args
   end
+
 end

data/lib/snippr/view_helper.rb

@@ -0,0 +1,71 @@
+# = Snippr::ViewHelper
+#
+# This module is automatically included into +ActionView::Base+ when using the Snippr
+# component with Rails. It provides a +snippr+ helper method for loading snippr files.
+#
+#   %h1 Topup successful
+#   .topup.info
+#     = snippr :topup, :success
+#   %h1 Conditional output
+#   - snippr :topup, :conditional_snippr do |snip|
+#     #cond= snip
+module Snippr
+  module ViewHelper
+
+    # Returns a snippr specified via +args+.
+    def snippr(*args)
+      snip = Snip.new *add_view_to_snippr_args(args)
+      content = snip.content.html_safe
+
+      if block_given?
+        if snip.missing? || snip.blank?
+          concat content
+        elsif content.strip.present?
+          yield content
+        end
+        0
+      else
+        extend_snip_content(content, snip)
+      end
+    end
+
+    def snippr_with_path(*args, &block)
+      path = if controller_name == "pages"
+        params[:id].split('/')
+      else
+        [controller_name, params[:action]]
+      end.compact.map { |e| e.to_s.camelize(:lower).to_sym }
+      snippr(*(path + args), &block)
+    end
+
+  private
+
+    def add_view_to_snippr_args(args)
+      variables = args.last.kind_of?(Hash) ? args.pop : {}
+      variables[:view] = self
+      args << variables
+      args
+    end
+
+    def extend_snip_content(content, snip)
+      content.class_eval %(
+        def missing?
+          #{snip.missing?}
+        end
+        def exists?
+          #{!snip.missing?}
+        end
+        def meta(key = nil)
+          meta = #{snip.meta.inspect}
+          key ? meta[key] : meta
+        end
+      )
+      content
+    end
+
+  end
+end
+
+if defined? ActionView::Base
+  ActionView::Base.send :include, Snippr::ViewHelper
+end

data/snippr.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = "snippr"
+  s.version     = "0.13.1"
+  s.date        = Time.now
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daniel Harrington", "Thomas Jachmann"]
+  s.email       = ["me@rubiii.com", "self@thomasjachmann.com"]
+  s.homepage    = "http://github.com/blaulabs/snippr"
+  s.summary     = %q{File based content management}
+  s.description = %q{This gem provides ways to access file based cms resources from a rails app.}
+
+  s.rubyforge_project = "snippr"
+
+  s.add_runtime_dependency "i18n"
+  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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/fixtures/a/path/aSnippet.snip

@@ -0,0 +1 @@
+a snippet

data/spec/fixtures/a/path/aSnippetWithParam.snip

@@ -0,0 +1 @@
+a snippet with param {param}

data/spec/fixtures/controller/action/aSnippet.snip

@@ -0,0 +1 @@
+SNIPPET

data/spec/fixtures/empty.snip

@@ -0,0 +1,3 @@
+  
+
+ 

data/spec/fixtures/meta/broken.snip

@@ -0,0 +1,5 @@
+---
+description: Die mit dem Fluegli
+  keywords: blau Mobilfunk GmbH, blau.de, blauworld, handy, sim
+---
+<p>Broken!</p>

data/spec/fixtures/meta/withContent.snip

@@ -0,0 +1,5 @@
+---
+description: Die mit dem Fluegli
+keywords: blau Mobilfunk GmbH, blau.de, blauworld, handy, sim
+---
+<p>So meta!</p>