snippr 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+== 0.1.0 (2010-04-30)
+  * Initial version.

data/README.rdoc

@@ -0,0 +1,62 @@
+= Snippr
+==== File based content management
+
+A snippr is a piece of HTML to be included in a website. They are plain text
+files stored on the file system.
+
+== Snippr path
+
+You need to specify the path to the snippr directory:
+
+  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 +SnipprPath::JVMProperty+. This allows system
+administrators to change the path without having to touch your application.
+
+== Instantiation
+
+Instantiating a new snippr is done by passing in the path to the snippr file as
+a String (including path separators):
+
+  Snippr.new "tariff/einheit"
+
+or by using multiple Strings or Symbols:
+
+  Snippr.new :tariff, :einheit
+
+=== Dynamic values
+
+A snippr 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 instantiating a new snippr.
+
+  Snippr.new :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>
+
+== Links
+
+...
+
+== Snippr content
+
+Returning the snippr content is done by calling the +to_s+ method. This will replace
+all specified placeholders and links.
+
+  Snippr.new(:tariff, :einheit).to_s
+
+== Rails Helper
+
+When using the Snippr component with Rails, it automatically adds the +SnipprHelper+
+module to your views. You can then use the +snippr+ helper method to load snippr files.
+
+  %h1 Topup successful
+  .topup.info
+    = snippr :topup, :success

data/Rakefile

@@ -0,0 +1,31 @@
+require "rake"
+require "spec/rake/spectask"
+require "spec/rake/verify_rcov"
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |t|
+#  t.rcov = true
+#  t.rcov_opts = %w(--exclude-only ^\/User,spec\/)
+end
+
+namespace :spec do
+  RCov::VerifyTask.new(:rcov => :spec) do |t|
+    t.threshold = 90
+    t.index_html = "coverage/index.html"
+  end
+end
+
+begin
+  require "hanna/rdoctask"
+
+  Rake::RDocTask.new do |t|
+    t.title = "Snippr - File based content management"
+    t.rdoc_dir = "doc"
+    t.rdoc_files.include("**/*.rdoc").include("lib/**/*.rb")
+    t.options << "--line-numbers"
+    t.options << "--webcvs=http://github.com/blaulabs/snippr/tree/master/"
+  end
+rescue LoadError
+  puts "'gem install hanna' for documentation"
+end

data/lib/snippr/core_ext.rb

@@ -0,0 +1,12 @@
+class String
+
+  # Returns the String in lowerCamelCase.
+  def lower_camelcase
+    str = dup
+    str.gsub!(/\/(.?)/) { "::#{$1.upcase}" }
+    str.gsub!(/(?:_+|-+)([a-z])/) { $1.upcase }
+    str.gsub!(/(\A|\s)([A-Z])/) { $1 + $2.downcase }
+    str
+  end
+
+end

data/lib/snippr/snippr.rb

@@ -0,0 +1,114 @@
+# = Snippr
+# ==== File based content management
+#
+# A snippr is a piece of HTML to be included in a website. They are plain text
+# files stored on the file system.
+#
+# == Snippr path
+#
+# You need to specify the path to the snippr directory:
+#
+#   Snippr.path = File.join(File.dirname(__FILE__), "..", "snipprs")
+#
+# When running on JRuby, you can also set the path via JVM properties. The property
+# you need to specify is defined in +SnipprPath::JVMProperty+. This allows system
+# administrators to change the path without having to touch your application.
+#
+# == Instantiation
+#
+# Instantiating a new snippr is done by passing in the path to the snippr file as
+# a String (including path separators):
+#
+#   Snippr.new "tariff/einheit"
+#
+# or by using multiple Strings or Symbols:
+#
+#   Snippr.new :tariff, :einheit
+#
+# === Dynamic values
+#
+# A snippr 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 instantiating a new snippr.
+#
+#   Snippr.new :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>
+#
+# == Links
+#
+# ...
+#
+# == Snippr content
+#
+# Returning the snippr content is done by calling the +to_s+ method. This will replace
+# all specified placeholders and links.
+#
+#   Snippr.new(:tariff, :einheit).to_s
+#
+# == Rails Helper
+#
+# When using the Snippr component with Rails, it automatically adds the +SnipprHelper+
+# module to your views. You can then use the +snippr+ helper method to load snippr files.
+#
+#   %h1 Topup successful
+#   .topup.info
+#     = snippr :topup, :success
+class Snippr
+  extend SnipprPath
+
+  # The snippr file extension.
+  SnipprFileExtension = ".snip"
+
+  # The comments wrapping a snippr.
+  SnipprWrapper = "<!-- starting with snippr: %s -->\n%s\n<!-- ending with snippr: %s -->"
+
+  # The fallback for a missing snippr.
+  MissingSnippr = '<samp class="missing snippr" />'
+
+  # Expects the paths to a snippr. Also accepts a Hash of placeholders
+  # to be replaced with dynamic values.
+  def initialize(*args)
+    @dynamic_values = args.last.kind_of?(Hash) ? args.pop : {}
+    @snippr_name = args.map { |arg| arg.kind_of?(Symbol) ? arg.to_s.lower_camelcase : arg }.join("/")
+  end
+
+  # Returns the snippr content.
+  def to_s
+    wrap_in_comments { snippr }
+  end
+
+private
+
+  # Returns the raw snippr content or a +MissingSnippr+ tag in case
+  # the snippr file does not exist.
+  def snippr
+    return MissingSnippr unless File.exist? snippr_file
+    
+    snippr = File.read(snippr_file).strip
+    insert_dynamic_values snippr
+    snippr
+  end
+
+  # Replaces placeholders with dynamic values.
+  def insert_dynamic_values(snippr)
+    @dynamic_values.each { |placeholder, value| snippr.gsub! "{#{placeholder}}", value.to_s }
+  end
+
+  # Returns the complete path to a snippr file.
+  def snippr_file
+    File.join self.class.path, "#{@snippr_name}#{SnipprFileExtension}"
+  end
+
+  # Wraps the content from a given +block+ in descriptive comments.
+  def wrap_in_comments
+    SnipprWrapper % [@snippr_name, yield, @snippr_name]
+  end
+
+end

data/lib/snippr/snippr_helper.rb

@@ -0,0 +1,20 @@
+# = SnipprHelper
+#
+# This module is automatically included into +ActionView::Base+ when using the Snippr
+# component with Rails. It provides a +snippr+ helper method for loading snipprs.
+#
+#   %h1 Topup successful
+#   .topup.info
+#     = snippr :topup, :success
+module SnipprHelper
+
+  # Returns a snippr specified via +args+.
+  def snippr(*args)
+    Snippr.new(*args).to_s
+  end
+
+end
+
+if defined? ActionView::Base
+  ActionView::Base.send :include, SnipprHelper
+end

data/lib/snippr/snippr_path.rb

@@ -0,0 +1,38 @@
+# = SnipprPath
+#
+# This module is included into the Snippr component for retrieving and setting
+# the path to the snippr files.
+module SnipprPath
+
+  # The snippr path JVM property.
+  JVMProperty = "cms.snippet.path"
+
+  # Returns the snippr path from JVM properties.
+  def path
+    JavaLang::System.get_property(JVMProperty) rescue @path
+  end
+
+  # Sets the snippr path as a JVM property.
+  def path=(path)
+    path = path.to_s
+    raise ArgumentError, "Invalid path: #{path}" unless File.directory? path
+    JavaLang::System.set_property(JVMProperty, path) if jruby?
+    @path = path
+  end
+
+private
+
+  # Returns whether the current Ruby platform is JRuby.
+  def jruby?
+    RUBY_PLATFORM =~ /java/
+  end
+
+  module_function :jruby?
+
+  if jruby?
+    module JavaLang
+      include_package "java.lang"
+    end
+  end
+
+end

data/lib/snippr.rb

@@ -0,0 +1,4 @@
+require "snippr/core_ext"
+require "snippr/snippr_path"
+require "snippr/snippr_helper"
+require "snippr/snippr"

data/spec/fixtures/home.snip

@@ -0,0 +1 @@
+<p>Home</p>

data/spec/fixtures/tariff/einheit.snip

@@ -0,0 +1 @@
+<p>tariff: einheit</p>

data/spec/fixtures/topup/someError.snip

@@ -0,0 +1 @@
+<p>Some error occurred.</p>

data/spec/fixtures/topup/success.snip

@@ -0,0 +1 @@
+<p>You're topup of {topup_amount} at {date_today} was successful.</p>

data/spec/snippr/core_ext_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe String do
+
+  describe "lower_camelcase" do
+    it "converts a snakecase String to lowerCamelCase" do
+      "lower_camel_case".lower_camelcase.should == "lowerCamelCase"
+    end
+  end
+
+end

data/spec/snippr/snippr_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Snippr do
+  before :all do
+    snippr_path = File.join File.dirname(__FILE__), "..", "fixtures"
+    
+    if RUBY_PLATFORM =~ /java/
+      SnipprPath::JavaLang::System.set_property SnipprPath::JVMProperty, snippr_path
+    else
+      Snippr.path = snippr_path
+    end
+  end
+
+  it "should return the content of a snippr" do
+    Snippr.new(:home).to_s.should include("<p>Home</p>")
+  end
+
+  it "should return the content a snippr from a subfolder" do
+    Snippr.new("tariff/einheit").to_s.should include("<p>tariff: einheit</p>")
+  end
+
+  it "should return the content a snippr from a subfolder specified via multiple arguments" do
+    Snippr.new(:tariff, :einheit).to_s.should include("<p>tariff: einheit</p>")
+  end
+
+  it "should convert snake_case Symbols to lowerCamelCase Strings" do
+    Snippr.new(:topup, :some_error).to_s.should include("<p>Some error occurred.</p>")
+  end
+
+  it "should wrap the snippr in descriptive comments" do
+    Snippr.new(:home).to_s.should ==
+      "<!-- starting with snippr: home -->\n" <<
+      "<p>Home</p>\n" <<
+      "<!-- ending with snippr: home -->"
+  end
+
+  it "should replace placeholders with dynamic values" do
+    snippr = Snippr.new :topup, :success, :topup_amount => "15,00 &euro;", :date_today => Date.today
+    snippr.to_s.should include("<p>You're topup of 15,00 &euro; at #{Date.today} was successful.</p>")
+  end
+
+  it "should return a fallback wrapped in descriptive comments for missing snipprs" do
+    Snippr.new(:doesnotexist).to_s.should ==
+      "<!-- starting with snippr: doesnotexist -->\n" <<
+      "<samp class=\"missing snippr\" />\n" <<
+      "<!-- ending with snippr: doesnotexist -->"
+  end
+
+  it "should raise an ArgumentError if the +path+ does not exist" do
+    lambda { Snippr.path = "does_not_exist" }.should raise_exception(ArgumentError)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "spec"
+require "date"
+
+require "snippr"

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: snippr
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Harrington
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-30 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 8
+        version: 1.2.8
+  type: :development
+  version_requirements: *id001
+description: 
+email: me@rubiii.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- CHANGELOG
+- Rakefile
+- README.rdoc
+- lib/snippr/core_ext.rb
+- lib/snippr/snippr.rb
+- lib/snippr/snippr_helper.rb
+- lib/snippr/snippr_path.rb
+- lib/snippr.rb
+- spec/snippr/core_ext_spec.rb
+- spec/snippr/snippr_spec.rb
+- spec/spec_helper.rb
+- spec/fixtures/home.snip
+- spec/fixtures/tariff/einheit.snip
+- spec/fixtures/topup/someError.snip
+- spec/fixtures/topup/success.snip
+has_rdoc: true
+homepage: http://github.com/blaulabs/snippr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --line-numbers
+- --inline-source
+- --title
+- Snippr - File based content management
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: File based content management
+test_files: 
+- spec/snippr/core_ext_spec.rb
+- spec/snippr/snippr_spec.rb
+- spec/spec_helper.rb