snippr 0.14.1 → 0.15.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTAxMWYzNWFmOWYyMTc1OTM5MjAwYzM1Nzg1ZjQwNTIzZDNjNzU2Yg==
+    ZTNiMGU0NWMwNzRlNWFkODQ0NTNhNWVkZjQ0M2FmNTRiZDg2MzFkNA==
   data.tar.gz: !binary |-
-    MzVkNWE2NjM5NzMyYjI2MWVhZjFmYjUzZDg1YjQ4Y2VkN2Q2NzJiYw==
+    ZGNjZWJjMDI5YzU5MmJhNzBhNTBmZDQ3OWQ3ZWFiNzU0ZmUyZjMyYw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NGI2MGNmYjY2MGQzZmZkOGRhYTFiNDg0NjFmODRhZDMyMjQ4YzI3OWY4NWMx
-    NDI4YjE0YTFjMTkzZDZlNmFiYjk3NTIwNGI4Y2ZmMWUyMDA2YTc3NTU2ODYz
-    ODI0Mzg3YjU1NTZlN2JkOGIzNDc3NGMzZjg5MTBiYTc4OGRmZDc=
+    MGY2NmE3OTAyYzYyYTUzZWQ5OWNhOTVlZDgxZDAyOWVjODZlMmM0NDBjODE1
+    ZWQ5NDc1MWJlY2YxODkwZDhjMTBlM2MwNmRmMTNjMGVjNTVhZGIzOThjODlj
+    MWQxYzg5ODY5NDk3M2UwZjk2YmQ0MDA0OGQxMzJjMjdmZWZiYTU=
   data.tar.gz: !binary |-
-    MDE4OTgyYzQ5MDAyOWUyMWU3MTU5YTE3MjliMzRmZWU0N2Y5ZTgyNGVlMjRl
-    Yjc3YmQzMmRiYjM5OGU4YWZiY2Q1Nzg1YTE0NzBiNDgxNDZmOWM3ZDI4ZmMz
-    NWNkMjlkM2Y5ZDViMmIyMTdhOWUxNjJhMjVjNzQ5NWVlYjlmODM=
+    ZTNkYzZkNzU3NGFkODgyZWVlYmViOWQ0NGM4NDBkMjNmY2JhNGNkN2QyMmM1
+    ZjlhMmY4YzkwNzg2ZTM3MmFiY2M3OGEwY2ZhMTk5N2U4MDYxNmY3NWZmMGQx
+    NjQ2OGI2YWRkNjVjNWE3YjJlZDQ1ZWJiOWZlYjc0ZWI2Y2U5ZmM=

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) blaulabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -94,7 +94,7 @@ is equivalent to
 
 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.
+Inspired by [jekyll](http://jekyllrb.com) a snippet can host metadata that is 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.
@@ -121,6 +121,33 @@ You can pass additional dynamic values when using `{snip}`. These will override
 
 Those will be available as {dyn_key1} and {dyn_key2} in filepath/of/snip.snip
 
+### Segments (as of Snippr 0.15.0)
+
+A snippet file can contain multiple snippet "segments".  
+Those segment are delimited by a line containing only `==== somefilter: filtervalue ====`.  
+Since there can be only one active content per snippet you must use segmentfilters to determine which segment of the enippet to use.  
+
+Currently there are the following filters:  
+
+#### valid_from
+`valid_from: YYYY-MM-DD HH:MM:SS` :  
+Activates the following snippet section if the current date is greater than the timestamp passed as the filtervalue.  
+  
+    First segment
+    ==== valid_from: 2013-05-17 13:15:00 ====
+    Second segement
+
+Here the second segment would be the content on and after 2013-05-17 13:15:00.
+
+#### valid_until
+`valid_until: YYYY-MM-DD HH:MM:SS` :  
+Same as `valid_from` only the other way round
+
+#### on_rails_env
+`on_rails_env: production`:  
+Shows the snippet only in the given environment(s).  
+Separate environments with a comma (eg. production,test,unstable)
+
 ## I18n
 
 Snippr comes with support for I18n, but up until further notice, you have to manually enable this

data/lib/snippr/segment_filter/base.rb

@@ -0,0 +1,23 @@
+module Snippr
+  module SegmentFilter
+    class Base
+
+      def initialize(filter_value)
+        @filter_value = filter_value
+      end
+
+      def self.filters
+        @available_filters
+      end
+
+      def self.inherited(subclass)
+        @available_filters ||= []
+        @available_filters << subclass
+      end
+
+      def active?
+        raise RuntimeException("Subclasses need to implement #active?")
+      end
+    end
+  end
+end

data/lib/snippr/segment_filter/on_rails_env.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+module Snippr
+  module SegmentFilter
+    class OnRailsEnv < Base
+      def active?
+        if defined?(Rails) && in_env?
+          true
+        else
+          false
+        end
+      end
+
+      private
+
+      def in_env?
+        sources.include?(Rails.env)
+      end
+
+      def sources
+        @sources ||= @filter_value.split(",").map(&:strip)
+      end
+    end
+  end
+end

data/lib/snippr/segment_filter/valid_from.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+module Snippr
+  module SegmentFilter
+    class ValidFrom < Base
+      def active?
+        DateTime.now.to_s >= DateTime.strptime(@filter_value, "%Y-%m-%d %H:%M").to_s
+      rescue ArgumentError
+        false
+      end
+    end
+  end
+end

data/lib/snippr/segment_filter/valid_until.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+module Snippr
+  module SegmentFilter
+    class ValidUntil < Base
+      def active?
+        DateTime.now.to_s <= DateTime.strptime(@filter_value, "%Y-%m-%d %H:%M").to_s
+      rescue ArgumentError
+        false
+      end
+    end
+  end
+end

data/lib/snippr/segment_parser.rb

@@ -0,0 +1,46 @@
+# -*- encoding : utf-8 -*-
+module Snippr
+  class SegmentParser
+
+    SEGMENT_MARKER = /[=✄]{4}\s(.*?):\s(.*?)\s[=✄]{4}/
+
+    def initialize(raw_content)
+      @raw_content = insert_dummy_filter(raw_content.clone)
+    end
+
+    def content
+      @content ||= @raw_content.scan(/[=✄]{4}$\n(.*?)\n?(?:\z|[=✄]{4})/m)[find_active_segment][0]
+    end
+
+    private
+
+    def filters
+      @filters ||= extract_filters
+    end
+
+    def find_active_segment
+      active_segment = 0
+      filters.each_with_index do |filter, filter_index|
+        filter_class = Snippr::SegmentFilter::Base.filters.detect {|c| c.name == "Snippr::SegmentFilter::#{camel_case(filter[:name])}" }
+        active_segment = filter_index and break if filter_class && filter_class.new(filter[:value]).active?
+      end
+      active_segment
+    end
+
+    def extract_filters
+      @raw_content.scan(/^[=✄]{4}\s(.*?):\s(.*?)\s[=✄]{4}$/).map {|filter| { :name => filter[0], :value => filter[1] } }
+    end
+
+    def camel_case(str)
+      return str if str !~ /_/ && str =~ /[A-Z]+.*/
+      str.split('_').map{|e| e.capitalize}.join
+    end
+
+    def insert_dummy_filter(content)
+      if content !~ /\A#{SEGMENT_MARKER}$/
+        content.prepend("==== dummy: filter ====\n")
+      end
+      content
+    end
+  end
+end

data/lib/snippr/snip.rb

@@ -25,7 +25,8 @@ module Snippr
         if missing?
           "<!-- missing snippr: #{name} -->"
         else
-          content = Processor.process unprocessed_content, opts
+          content = SegmentParser.new(@unprocessed_content).content
+          content = Processor.process content, opts
           "<!-- starting snippr: #{name} -->\n#{content}\n<!-- closing snippr: #{name} -->"
         end
       end

data/lib/snippr/view_helper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # = Snippr::ViewHelper
 #
 # This module is automatically included into +ActionView::Base+ when using the Snippr

data/lib/snippr.rb

@@ -12,6 +12,12 @@ require 'snippr/processor'
 require 'snippr/railtie' if defined?(Rails)
 require 'snippr/view_helper'
 
+require 'snippr/segment_parser'
+require 'snippr/segment_filter/base'
+require 'snippr/segment_filter/valid_from'
+require 'snippr/segment_filter/valid_until'
+require 'snippr/segment_filter/on_rails_env' if defined?(Rails)
+
 require 'snippr/normalizer/camelizer'
 require 'snippr/normalizer/de_rester'
 

data/snippr.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "snippr"
-  s.version     = "0.14.1"
+  s.version     = "0.15.3"
   s.date        = Time.now
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Daniel Harrington", "Thomas Jachmann"]

data/spec/snippr/segment_filter/base_spec.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+require "spec_helper"
+
+describe "Snippr::SegmentFilter::Base" do
+  it "remembers its subclasses" do
+    Snippr::SegmentFilter::Base.should have(3).filters
+  end
+end

data/spec/snippr/segment_filter/on_rails_env_spec.rb

@@ -0,0 +1,26 @@
+# -*- encoding : utf-8 -*-
+require "spec_helper"
+require "snippr/segment_filter/on_rails_env"
+
+describe "Snippr::SegmentFilter::OnRailsEnv" do
+  before do
+    Rails = Class.new { def self.env; "test"; end}
+  end
+
+  after do
+    Object.send(:remove_const, :Rails)
+  end
+
+  it "is active in the defined environment" do
+    Rails.expects(:env).returns("test")
+    Snippr::SegmentFilter::OnRailsEnv.new("test").should be_active
+  end
+
+  it "is not active in other environments" do
+    Snippr::SegmentFilter::OnRailsEnv.new("non-existing-env").should_not be_active
+  end
+
+  it "allows multiple environments to be given" do
+    Snippr::SegmentFilter::OnRailsEnv.new("a_env, test, development,     foobar").should be_active
+  end
+end

data/spec/snippr/segment_filter/valid_from_spec.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+require "spec_helper"
+
+describe "Snippr::SegmentFilter::ValidFrom" do
+  it "returns true if the filter date is before now" do
+    Snippr::SegmentFilter::ValidFrom.new("1976-03-10 09:00:00").should be_active
+  end
+
+  it "returns false if the filter date is after now" do
+    Snippr::SegmentFilter::ValidFrom.new("9999-03-10 09:00:00").should_not be_active
+  end
+
+  it "returns false if the filter date is unparsable" do
+    Snippr::SegmentFilter::ValidFrom.new("99990310090000").should_not be_active
+  end
+end

data/spec/snippr/segment_filter/valid_until_spec.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+require "spec_helper"
+
+describe "Snippr::SegmentFilter::ValidUntil" do
+  it "returns false if the filter date is before now" do
+    Snippr::SegmentFilter::ValidUntil.new("1976-03-10 09:00:00").should_not be_active
+  end
+
+  it "returns true if the filter date is after now" do
+    Snippr::SegmentFilter::ValidUntil.new("9999-03-10 09:00:00").should be_active
+  end
+
+  it "returns false if the filter date is unparsable" do
+    Snippr::SegmentFilter::ValidUntil.new("99990310090000").should_not be_active
+  end
+end

data/spec/snippr/segment_parser_spec.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+require "spec_helper"
+
+describe "SegmentParser" do
+
+  it "allows scissor symbols to be the delimiter. yay!" do
+    actual = Snippr::SegmentParser.new("a\n=✄== valid_from: 3099-05-01 09:00:00 ====\nb").content.should == "a"
+  end
+
+  it "chooses the correct segment if no condition is given" do
+    actual = Snippr::SegmentParser.new("a\nb").content.should == "a\nb"
+  end
+
+  it "chooses the correct segment if no valid condition is given" do
+    actual = Snippr::SegmentParser.new("a\n==== valid_from: 3099-05-01 09:00:00 ====\nb").content.should == "a"
+  end
+
+  it "chooses the correct segment if a valid condition is given" do
+    actual = Snippr::SegmentParser.new("a\n==== valid_from: 1099-05-01 09:00:00 ====\nb").content.should == "b"
+  end
+
+  it "returns the first matching segment if multiple segments are given" do
+    actual = Snippr::SegmentParser.new("a\n==== valid_from: 1099-05-01 09:00:00 ====\nb\n==== valid_from: 1100-05-01 09:00:00 ====\nc").content.should == "b"
+  end
+
+  it "can handle more than two segments" do
+    actual = Snippr::SegmentParser.new("a\n==== valid_from: 6099-05-01 09:00:00 ====\nb\n==== valid_from: 1100-05-01 09:00:00 ====\nc").content.should == "c"
+  end
+end

data/spec/snippr/snip_spec.rb

@@ -43,7 +43,7 @@ describe Snippr::Snip do
         snip.opts.should == { :i18n => true }
       end
 
-      it "returns no double slahes in the path for nil value" do
+      it "returns no double slashes in the path for nil value" do
         snip = Snippr::Snip.new(:path_to_snips, nil ,:file)
         snip.name.should == 'pathToSnips/file'
         snip.path.should == 'path/pathToSnips/file.snip'
@@ -119,29 +119,24 @@ describe Snippr::Snip do
 
   end
 
-  [:content, :to_s].each do |method|
+  describe "content" do
 
-    describe "##{method}" do
-
-      it "calls Snippr::Processor.process with opts and return decorated result" do
-        Snippr::Processor.expects(:process).with('<p>Home</p>', {:a => :b}).returns('processed')
-        Snippr::Snip.new(:home, :a => :b).send(method).should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
-      end
-
-      it "stores the processed data instead of processing it again" do
-        Snippr::Processor.expects(:process).with('<p>Home</p>', {:a => :b}).once.returns('processed')
-        snip = Snippr::Snip.new(:home, :a => :b)
-        snip.send(method).should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
-        snip.send(method).should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
-      end
-
-      it "doesn't call Snippr::Processor.process and return missing string" do
-        Snippr::Processor.expects(:process).never
-        Snippr::Snip.new(:doesnotexist, :a => :b).send(method).should == '<!-- missing snippr: doesnotexist -->'
-      end
+    it "calls Snippr::Processor.process with opts and return decorated result" do
+      Snippr::Processor.expects(:process).with('<p>Home</p>', {:a => :b}).returns('processed')
+      Snippr::Snip.new(:home, :a => :b).content.should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
+    end
 
+    it "stores the processed data instead of processing it again" do
+      Snippr::Processor.expects(:process).with('<p>Home</p>', {:a => :b}).once.returns('processed')
+      snip = Snippr::Snip.new(:home, :a => :b)
+      snip.content.should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
+      snip.content.should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
     end
 
+    it "doesn't call Snippr::Processor.process and return missing string" do
+      Snippr::Processor.expects(:process).never
+      Snippr::Snip.new(:doesnotexist, :a => :b).content.should == '<!-- missing snippr: doesnotexist -->'
+    end
   end
 
   describe "#missing?" do

data/spec/snippr/snippr_spec.rb

@@ -1,38 +1,39 @@
+# -*- encoding : utf-8 -*-
 require "spec_helper"
 
 describe Snippr do
 
-  it "should delegate path to Snippr::Path.path" do
+  it "delegates path to Snippr::Path.path" do
     Snippr::Path.should respond_to(:path)
     Snippr::Path.expects(:path).returns('path')
     subject.path.should == 'path'
   end
 
-  it "should delegate path= to Snippr::Path.path=" do
+  it "delegates path= to Snippr::Path.path=" do
     Snippr::Path.should respond_to(:path=)
     Snippr::Path.expects(:path=).with('path')
     subject.path = 'path'
   end
 
-  it "should delegate i18n? to Snippr::I18n.enabled?" do
+  it "delegates i18n? to Snippr::I18n.enabled?" do
     Snippr::I18n.should respond_to(:enabled?)
     Snippr::I18n.expects(:enabled?).returns(true)
     subject.i18n?.should == true
   end
 
-  it "should delegate i18n= to Snippr::I18n.enabled=" do
+  it "delegates i18n= to Snippr::I18n.enabled=" do
     Snippr::I18n.should respond_to(:enabled=)
     Snippr::I18n.expects(:enabled=).with(true)
     subject.i18n = true
   end
 
-  it "should delegate adjust_urls_except? to Snippr::Links.adjust_urls_except" do
+  it "delegates adjust_urls_except? to Snippr::Links.adjust_urls_except" do
     Snippr::Links.should respond_to(:adjust_urls_except)
     Snippr::Links.expects(:adjust_urls_except).returns([1])
     subject.adjust_urls_except.should == [1]
   end
 
-  it "should delegate adjust_urls_except= to Snippr::Links.adjust_urls_except=" do
+  it "delegates adjust_urls_except= to Snippr::Links.adjust_urls_except=" do
     Snippr::Links.should respond_to(:adjust_urls_except=)
     Snippr::Links.expects(:adjust_urls_except=).with([2])
     subject.adjust_urls_except = [2]
@@ -71,12 +72,12 @@ describe Snippr do
 
   end
 
-  it "should delegate load to Snippr::Snip.new" do
+  it "delegates load to Snippr::Snip.new" do
     Snippr::Snip.expects(:new).with(:a, :b).returns('snip')
     subject.load(:a, :b).should == 'snip'
   end
 
-  it "should delegate list to Snippr::Path.list" do
+  it "delegates list to Snippr::Path.list" do
     Snippr::Path.expects(:list).with(:c, :d).returns([:snip])
     subject.list(:c, :d).should == [:snip]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snippr
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.3
 platform: ruby
 authors:
 - Daniel Harrington
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -123,6 +123,7 @@ files:
 - .travis.yml
 - CHANGELOG
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/snippr.rb
@@ -140,6 +141,11 @@ files:
 - lib/snippr/processor/links.rb
 - lib/snippr/processor/wikilinks.rb
 - lib/snippr/railtie.rb
+- lib/snippr/segment_filter/base.rb
+- lib/snippr/segment_filter/on_rails_env.rb
+- lib/snippr/segment_filter/valid_from.rb
+- lib/snippr/segment_filter/valid_until.rb
+- lib/snippr/segment_parser.rb
 - lib/snippr/snip.rb
 - lib/snippr/snippr.rb
 - lib/snippr/view_helper.rb
@@ -172,6 +178,11 @@ files:
 - spec/snippr/processor/links_spec.rb
 - spec/snippr/processor/wikilinks_spec.rb
 - spec/snippr/processor_spec.rb
+- spec/snippr/segment_filter/base_spec.rb
+- spec/snippr/segment_filter/on_rails_env_spec.rb
+- spec/snippr/segment_filter/valid_from_spec.rb
+- spec/snippr/segment_filter/valid_until_spec.rb
+- spec/snippr/segment_parser_spec.rb
 - spec/snippr/snip_spec.rb
 - spec/snippr/snippr_spec.rb
 - spec/snippr/view_helper_spec.rb
@@ -229,6 +240,11 @@ test_files:
 - spec/snippr/processor/links_spec.rb
 - spec/snippr/processor/wikilinks_spec.rb
 - spec/snippr/processor_spec.rb
+- spec/snippr/segment_filter/base_spec.rb
+- spec/snippr/segment_filter/on_rails_env_spec.rb
+- spec/snippr/segment_filter/valid_from_spec.rb
+- spec/snippr/segment_filter/valid_until_spec.rb
+- spec/snippr/segment_parser_spec.rb
 - spec/snippr/snip_spec.rb
 - spec/snippr/snippr_spec.rb
 - spec/snippr/view_helper_spec.rb