liquid-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e9723ef54a8b5602a0eece9ecbf5a3eef85e53f
+  data.tar.gz: 660456e3598bacf1b5f435bea0b7875d46bd7a54
+SHA512:
+  metadata.gz: ff1a8eca8c43f25d3829951b86b55d747abb5d343224568919f7c25be686ca5a11c469de95111c78caede8327c708cb494fdb81af02b10a94cd671e02603bc5b
+  data.tar.gz: a596f42ec4296f3863f81dab54123ca1f47fbb6fe2d4c6e81ba401470f7cfd509b3737cebf9ca92c9a6d5be99def38238a4483603a785fd4311387447cf69286

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: stxQNkczi4haKGRjKZvd7i8PAooQrahCX

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+spec/dummy/log/*
+gemfiles/*.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+liquid-rails

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.3

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+script: "bundle exec rake spec"
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+env:
+  - CODECLIMATE_REPO_TOKEN=891d362268d07d6ff0f5534f92252b6195f6be8795054d3627643eb6314a8c9e
+gemfile:
+  - gemfiles/rails_40.gemfile
+  - gemfiles/rails_41.gemfile
+notifications:
+  email: false
+addons:
+  code_climate:
+    repo_token: 891d362268d07d6ff0f5534f92252b6195f6be8795054d3627643eb6314a8c9e

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in liquid-rails.gemspec
+gemspec
+
+gem 'rails',       '~> 4.0.10'
+gem 'rspec-rails', '~> 2.14.2'
+gem 'capybara',    '~> 2.4.1'
+gem 'pry-rails'
+gem 'coveralls'
+gem 'simplecov'
+gem 'guard-rspec'

data/Guardfile

@@ -0,0 +1,33 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chamnap Chhorn
+
+MIT License
+
+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,140 @@
+[![Build Status](https://travis-ci.org/yoolk/liquid-rails.svg?branch=master)](https://travis-ci.org/yoolk/liquid-rails)[![Coverage Status](https://coveralls.io/repos/yoolk/liquid-rails/badge.png?branch=master)](https://coveralls.io/r/yoolk/liquid-rails?branch=master)
+# Liquid-Rails
+
+It allows you to render `.liquid` templates with layout and partial support. It also provides filters, tags, drops class to be used inside your liquid template.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'liquid-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install liquid-rails
+
+## Usage
+
+In order to render with layout, in your layout file `app/views/layouts/application.liquid`, put this:
+
+```html
+{{ content_for_layout }}
+```
+
+```html
+# It will render app/views/home/_partial.liquid when the current controller is `HomeController`.
+{% include 'partial' %}
+
+# It will render app/views/shared/_partial.liquid.
+{% include 'shared/partial' %}
+```
+
+### Template Rendering
+
+By default, **Liquid-Rails** makes all instance variables from controller available to liquid template. To limit only some instance variables, do this inside your controller:
+
+```ruby
+def liquid_assigns
+  { 'listing' => current_listing, 'content_for_header' => content_for_header, 'current_account' => current_account }
+end
+```
+
+By default, **Liquid-Rails** makes all your helper methods inside your rails app available to liquid template. To limit only some helpers, do this inside your controller:
+
+```ruby
+def liquid_filters
+  []
+end
+```
+
+### Filter
+
+> Filters are simple methods that modify the output of numbers, strings, variables and objects. They are placed within an output tag `{{` `}}` and are separated with a pipe character `|`.
+
+Currently, **Liquid-Rails** adds only the followings:
+
+1. [AssetTagFilter](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/filters/asset_tag_filter.rb)
+2. [AssetUrlFilter](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/filters/asset_url_filter.rb)
+3. [DateFilter](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/filters/date_filter.rb)
+4. [NumberFilter](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/filters/number_filter.rb)
+5. [SanitizeFilter](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/filters/sanitize_filter.rb)
+6. [TextFilter](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/filters/text_filter.rb)
+7. [TranslateFilter](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/filters/translate_filter.rb)
+8. [UrlFilter](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/filters/url_filter.rb)
+9. [MiscFilter](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/filters/misc_filter.rb)
+
+### Tag
+
+> Liquid tags are the programming logic that tells templates what to do. Tags are wrapped in: `{%` `%}`.
+
+Currently, **Liquid-Rails** adds only the followings:
+
+1. [csrf_meta_tags](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/tags/csrf_meta_tags.rb)
+2. [google_analytics_tag](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/tags/google_analytics_tag.rb)
+3. [javascript_tag](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/tags/javascript_tag.rb)
+4. [paginate](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/tags/paginate_tag.rb)
+4. [content_for](https://github.com/yoolk/liquid-rails/blob/master/lib/liquid-rails/tags/content_for.rb)
+
+### Drop Class
+
+> Drops let you provide the user with custom functionality. They are very much like a standard Ruby class, but have all unused and potentially dangerous methods removed. From the user's perspective a drop acts very much like a Hash, though methods are accessed with dot-notation as well as element selection. A drop method cannot be invoked with arguments. Drops are called just-in-time, thus allowing you to lazily load objects.
+
+Given two models, a Post(title: string, body: text) and a Comment(name:string, body:text, post_id:integer), you will have two drops:
+
+```ruby
+class PostDrop < Liquid::Rails::Drop
+  attributes :id, :title, :body
+
+  has_many :comments
+end
+```
+
+and
+
+```ruby
+class CommentDrop < Liquid::Rails::Drop
+  attributes :id, :name, :body
+
+  belongs_to :post
+end
+```
+
+Check out more [examples](https://github.com/yoolk/liquid-rails/blob/master/spec/fixtures/poro.rb).
+
+It works for any ORMs. The PORO should include `Liquid::Rails::Droppable`. That's all you need to do to have your POROs supported.
+
+### RSpec
+
+In spec_helper.rb, you'll need to require the matchers:
+
+```ruby
+require 'liquid-rails/matchers'
+```
+
+Example:
+
+```ruby
+describe PostDrop do
+  it { should have_attribute(:id) }
+  it { should have_attribute(:title) }
+  it { should have_attribute(:body) }
+  it { should have_many(:comments) }
+end
+```
+
+```ruby
+describe CommentDrop do
+  it { should have_attribute(:id) }
+  it { should have_attribute(:name) }
+  it { should have_attribute(:body) }
+  it { should belongs_to(:post) }
+end
+```
+
+## Authors
+
+* [Chamnap Chhorn](https://github.com/chamnap)

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: 'spec:all'
+
+namespace :spec do
+  %w(rails_41 rails_40 rails_32).each do |gemfile|
+    desc "Run Tests against #{gemfile}"
+    task gemfile do
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake spec"
+    end
+  end
+
+  desc "Run Tests against rails versions"
+  task :all do
+    %w(rails_41 rails_40 rails_32).each do |gemfile|
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake spec"
+    end
+  end
+end

data/gemfiles/rails_32.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rails',       '~> 3.2.19'
+gem 'rspec-rails', '~> 2.14.2'
+gem 'capybara',    '~> 2.4.1'
+gem 'pry-rails'
+gem 'coveralls'
+gem 'simplecov'
+gem 'guard-rspec'
+
+gemspec path: '../'

data/gemfiles/rails_40.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rails',       '~> 4.0.10'
+gem 'rspec-rails', '~> 2.14.2'
+gem 'capybara',    '~> 2.4.1'
+gem 'pry-rails'
+gem 'coveralls'
+gem 'simplecov'
+gem 'guard-rspec'
+
+gemspec path: '../'

data/gemfiles/rails_41.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rails',       '~> 4.1.6'
+gem 'rspec-rails', '~> 2.14.2'
+gem 'capybara',    '~> 2.4.1'
+gem 'pry-rails'
+gem 'coveralls'
+gem 'simplecov'
+gem 'guard-rspec'
+
+gemspec path: '../'

data/lib/liquid-rails.rb

@@ -0,0 +1,23 @@
+require 'liquid-rails/version'
+require 'liquid'
+require 'kaminari'
+require 'active_support/concern'
+
+module Liquid
+  module Rails
+    autoload :TemplateHandler,  'liquid-rails/template_handler'
+    autoload :FileSystem,       'liquid-rails/file_system'
+
+    autoload :Drop,             'liquid-rails/drops/drop'
+    autoload :CollectionDrop,   'liquid-rails/drops/collection_drop'
+
+    def self.setup_drop(base)
+      base.class_eval do
+        include Liquid::Rails::Droppable
+      end
+    end
+  end
+end
+
+require 'liquid-rails/railtie' if defined?(Rails)
+Dir[File.dirname(__FILE__) + '/liquid-rails/{filters,tags,drops}/*.rb'].each { |f| require f }

data/lib/liquid-rails/drops/collection_drop.rb

@@ -0,0 +1,91 @@
+module Liquid
+  module Rails
+    class CollectionDrop < ::Liquid::Drop
+
+      class << self
+        attr_accessor :_scopes
+      end
+
+      def self.inherited(base)
+        base._scopes = []
+      end
+
+      def self.scope(*scope_names)
+        @_scopes.concat scope_names
+
+        scope_names.each do |scope_name|
+          define_method(scope_name) do
+            value = instance_variable_get("@_#{scope_name}")
+            return value if value
+
+            raise ArgumentError, "#{objects.class.name} doesn't define scope: #{scope_name}" unless objects.respond_to?(scope_name)
+            instance_variable_set("@_#{scope_name}", self.class.new(objects.send(scope_name)))
+          end
+        end
+      end
+
+      array_methods = Array.instance_methods - Object.instance_methods
+      delegate *array_methods, to: :dropped_collection
+      delegate :total_count, :total_pages, to: :objects
+
+      def initialize(objects, options={})
+        options.assert_valid_keys(:with)
+
+        @objects         = objects
+        @drop_class_name = options[:with]
+      end
+
+      def page(number)
+        self.class.new(objects.page(number))
+      end
+
+      def per(number)
+        self.class.new(objects.per(number))
+      end
+
+      def dropped_collection
+        @dropped_collection ||= @objects.map { |item| drop_item(item) }
+      end
+
+      def kind_of?(klass)
+        dropped_collection.kind_of?(klass) || super
+      end
+      alias_method :is_a?, :kind_of?
+
+      ## :[] is invoked by parser before the actual. However, this method has the same name as array method.
+      ## Override this, so it will work for both cases.
+      ## {{ post_drop.comments[0] }}
+      ## {{ post_drop.<other_methods> }}
+      def [](method)
+        if method.is_a?(Integer)
+          dropped_collection.at(method)
+        else
+          public_send(method)
+        end
+      end
+
+      ## Need to override this. I don't understand too, otherwise it will return an array of drop objects.
+      ## Need to return self so that we can do chaining.
+      def to_liquid
+        self
+      end
+
+      def inspect
+        "#<#{self.class.name} of #{drop_class} for #{objects.inspect}>"
+      end
+
+      protected
+
+        attr_reader :objects
+
+        def drop_class
+          @drop_class ||= @drop_class_name.is_a?(String) ? @drop_class_name.safe_constantize : @drop_class_name
+        end
+
+        def drop_item(item)
+          liquid_drop_class = drop_class || item.drop_class
+          liquid_drop_class.new(item)
+        end
+    end
+  end
+end