tb_liquid 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8ecad380e23288e05cc223b0a527a415d079ff0
+  data.tar.gz: 4bb34b1910e24133c404e2d70283a06e8a08ec47
+SHA512:
+  metadata.gz: 6b612b54c74f5c108773a584131ee897443ad4826999056dd16d1d196fe834e93c2efdb17909300c03ed33c0c0b1d971a223b22c58acdc87bd7e47788195dd20
+  data.tar.gz: 887f983f8f73b514270093c5763b4cee44871db1ddc3f93a3b0afc5cdac96a774dbbdd5199fc3a1e18c2dabe688d79a22207b6095ed594e30455d69d424c52be

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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

@@ -0,0 +1,32 @@
+# TB Liquid
+
+TB Liquid is a simple gem that helps manage liquid tags within your Twice Baked application. Specifically, TB Liquid provides reusable code to handle expiring content when a liquid tag has changed. 
+
+## Use Case
+
+Say you have a `SpudPage` object that contains your custom liquid tag called `widget`. The `widget` tag is based on your `Widget` data model. Any time a change is made to your data, you'll need to send a message to `SpudPage` asking it to re-process it's content. TB Liquid helps faciliate this.
+
+## Code Sample
+
+In this example, `:widget` represents the liquid tag name and `:name` represents the model property used to fetch the liquid tag value. This can be any column or method on your model object. 
+
+    class Widget < ActiveRecord::Base
+      acts_as_spud_liquid_tag :widget, :name
+    end
+
+    class SpudPagePartial < ActiveRecord::Base
+      acts_as_spud_liquid_content
+      def postprocess_content
+        # handle liquid parsing here
+      end
+    end
+
+## How it Works
+
+The `acts_as_spud_liquid_tag` method adds an `after_update` hook to your model. The hook does a few things.
+
+- Find any `SpudLiquidTag` object with matching tag name and value properties. 
+- Call `postprocess_content` on any objects attached to any found tags.
+- That's it!
+
+The key is that the model attached to `SpudLiquidTag` must implement a `postprocess_content` method. Look at the `SpudPagePartial` model in TB CMS for an example implementation. 

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TbLiquid'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+#APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+#load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/concerns/tb_liquid/acts_as_liquid_content.rb

@@ -0,0 +1,36 @@
+module TbLiquid
+  module ActsAsLiquidContent
+    extend ActiveSupport::Concern
+    included do
+      extend ClassMethods
+    end
+
+    def postprocess_content()
+      raise 'Models that call acts_as_liquid_content should implement a postprocess_content method.'
+    end
+
+    def update_spud_liquid_tag_list()
+      if @spud_liquid_template_parsed.nil?
+        @spud_liquid_template_parsed = Liquid::Template.parse(self.content)
+      end
+      self.spud_liquid_tags.destroy_all
+      @spud_liquid_template_parsed.root.nodelist.each do |node|
+        if !node.is_a?(String) && defined?(node.tag_name) && defined?(node.tag_value)
+          self.spud_liquid_tags.create(:tag_name => node.tag_name,:value => node.tag_value)
+        end
+      end
+    end
+
+    module ClassMethods
+      attr_accessor :spud_liquid_template_parsed
+      def acts_as_spud_liquid_content
+        self.class_eval do
+          has_many :spud_liquid_tags, :as => :attachment, :dependent => :destroy
+          before_save :postprocess_content
+          after_save :update_spud_liquid_tag_list
+        end
+      end
+    end
+  end
+
+end

data/app/concerns/tb_liquid/acts_as_liquid_tag.rb

@@ -0,0 +1,38 @@
+module TbLiquid
+  module ActsAsLiquidTag
+    extend ActiveSupport::Concern
+    included do
+      extend ClassMethods
+    end
+
+    def expire_spud_liquid_tags
+      value_property = self.class.spud_liquid_tag_value_property
+      values = [self.send(value_property)]
+      if self.respond_to?("#{value_property}_changed?") && self.send("#{value_property}_changed?")
+        values << self.send("#{value_property}_was")
+      end
+      SpudLiquidTag.where(:tag_name => self.class.spud_liquid_tag_name, :value => values).includes(:attachment).each do |tag|
+        attachment = tag.attachment
+        if attachment.respond_to?(:postprocess_content)
+          attachment.postprocess_content()
+          attachment.save()
+        else
+          logger.debug "SpudLiquidTag attachment of class #{attachment.class} does not implement :postprocess_content."
+        end
+      end
+    end
+
+    module ClassMethods
+      attr_accessor :spud_liquid_tag_name, :spud_liquid_tag_value_property
+      def acts_as_spud_liquid_tag(tag_name, value_property)
+        @spud_liquid_tag_name = tag_name
+        @spud_liquid_tag_value_property = value_property
+        self.class_eval do
+          after_update :expire_spud_liquid_tags
+          after_touch :expire_spud_liquid_tags
+        end
+      end
+    end
+
+  end
+end

data/app/models/spud_liquid_tag.rb

@@ -0,0 +1,3 @@
+class SpudLiquidTag < ActiveRecord::Base
+  belongs_to :attachment, :polymorphic => true, :touch => true
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+TbLiquid::Engine.routes.draw do
+end

data/db/migrate/20140110142037_create_tb_liquid_spud_liquid_tags.rb

@@ -0,0 +1,12 @@
+class CreateTbLiquidSpudLiquidTags < ActiveRecord::Migration
+  def change
+    create_table :spud_liquid_tags do |t|
+      t.integer :attachment_id
+      t.string :attachment_type
+      t.string :tag_name
+      t.string :value
+      t.timestamps
+    end
+    add_index :spud_liquid_tags, [:tag_name, :value]
+  end
+end

data/lib/tasks/tb_liquid_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tb_liquid do
+#   # Task goes here
+# end

data/lib/tb_liquid/engine.rb

@@ -0,0 +1,18 @@
+require 'liquid'
+
+module TbLiquid
+  class Engine < ::Rails::Engine
+    isolate_namespace TbLiquid
+
+    require "#{root}/app/concerns/tb_liquid/acts_as_liquid_content"
+    require "#{root}/app/concerns/tb_liquid/acts_as_liquid_tag"
+
+    initializer 'tb_liquid.acts_as_spud_liquid_tag' do |config|
+      ActiveRecord::Base.class_eval do
+        include TbLiquid::ActsAsLiquidTag
+        include TbLiquid::ActsAsLiquidContent
+      end
+    end
+
+  end
+end

data/lib/tb_liquid/version.rb

@@ -0,0 +1,3 @@
+module TbLiquid
+  VERSION = "1.0.1"
+end

data/lib/tb_liquid.rb

@@ -0,0 +1,4 @@
+require "tb_liquid/engine"
+
+module TbLiquid
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: tb_liquid
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Westlake Design
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: tb_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simgle engine for managing liquid tags in Twice Baked.
+email:
+- greg@westlakedesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/concerns/tb_liquid/acts_as_liquid_content.rb
+- app/concerns/tb_liquid/acts_as_liquid_tag.rb
+- app/models/spud_liquid_tag.rb
+- config/routes.rb
+- db/migrate/20140110142037_create_tb_liquid_spud_liquid_tags.rb
+- lib/tasks/tb_liquid_tasks.rake
+- lib/tb_liquid.rb
+- lib/tb_liquid/engine.rb
+- lib/tb_liquid/version.rb
+homepage: http://bitbucket.org/westlakedesign/tb_liquid
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Simgle engine for managing liquid tags in Twice Baked.
+test_files: []