RubyGems - liquid-validations - Versions diffs - 1.0.1 - Mend

liquid-validations 1.0.1

Files changed (13) hide show

data/.gitignore +20 -0
data/.travis.yml +7 -0
data/Gemfile +4 -0
data/Gemfile.lock +39 -0
data/LICENSE.txt +22 -0
data/README.md +84 -0
data/Rakefile +11 -0
data/lib/liquid-validations.rb +56 -0
data/lib/liquid-validations/version.rb +3 -0
data/liquid-validations.gemspec +26 -0
data/spec/liquid_validations_spec.rb +64 -0
data/spec/spec_helper.rb +40 -0
metadata +150 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,20 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv-version
+*.db

data/.travis.yml ADDED Viewed

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0
+notifications:
+  email: false

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in liquid_validations.gemspec
+gemspec

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    liquid-validations (1.0.1)
+      activerecord
+      liquid
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activerecord (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    i18n (0.6.4)
+    liquid (2.5.0)
+    minitest (4.6.2)
+    multi_json (1.6.1)
+    rake (10.0.3)
+    sqlite3 (1.3.7)
+    tzinfo (0.3.37)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  liquid-validations!
+  minitest
+  rake
+  sqlite3

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Big Cartel, LLC
+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 ADDED Viewed

@@ -0,0 +1,84 @@
+# Liquid Validations [![Build Status](https://travis-ci.org/bigcartel/liquid-validations.png)](https://travis-ci.org/bigcartel/liquid-validations)
+ActiveRecord style validations for Liquid content in your ActiveRecord models.
+This gem makes 2 class methods available to your models:
+  * `validates_liquid_of` - Ensures that the liquid content is valid and has all opening/closing tags.
+  * `validates_presence_of_liquid_variable` - Useful to ensure your user content contains the specified Liquid variable(s).
+## Installation
+`gem 'liquid-validations'` in your Gemfile.
+Then `bundle install` and you should be all set.
+## Usage
+In it's simplest form:
+``` ruby
+class Article < ActiveRecord::Base
+  validates_liquid_of :content
+  validates_presence_of_liquid_variable :content, variable: 'very_important_variable'
+end
+```
+`validates_presence_of_liquid_variable` takes an optional `container` option like this:
+``` ruby
+validates_presence_of_liquid_variable :content,
+                                      variable: 'head_content',
+                                      container: 'head' # <html><head>{{ head_content }}</head>...
+```
+Which you may find useful for scoping. Or not.
+Each of these methods make use of ActiveModel's underlying [`validates_each`](http://apidock.com/rails/ActiveModel/Validations/ClassMethods/validates_each) method so any valid options passed in will be handed off.
+A fully tricked out example would be:
+``` ruby
+validates_liquid_of :content, :on => :create,
+                              :message => 'is invalid liquid.',
+                              :allow_nil => true,
+                              :allow_blank => true,
+                              :if => :needs_validation?,
+                              :unless => Proc.new { |record| record.new_record? }
+```
+Albeit, that's going a little overboard.
+## Compatibility
+Liquid Validations has been tested (used) with the following:
+#### Rails
+ * 2.3 and up
+ * 3
+#### Ruby
+ * 1.8
+ * 1.9
+ * 2.0
+That's not to say it won't work with Rails 1.2 or 4, but we haven't yet tested either of those.
+## What about Sinatra
+This *should* work outside of Rails as long as your models are using ActiveRecord as the database mapper. However, this is just in theory, and hasn't been tested yet.
+## Contributing
+If you do find that something is busted, or think improvements can be made
+ * Fork it
+ * Create a topic branch - `git checkout -b fix_rails_1-0`
+ * Push to your branch - `git push origin fix_rails_1-0`
+ * Create a Pull Request from your branch
+That's it!

data/Rakefile ADDED Viewed

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+task :default => :test
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end

data/lib/liquid-validations.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require 'liquid-validations/version'
+module LiquidValidations
+  def validates_liquid_of(*attr_names)
+    configuration = { :message => I18n.translate('activerecord.errors.messages')[:invalid] }
+    configuration.update(attr_names.extract_options!)
+    validates_each attr_names, configuration do |record, attr_name, value|
+      errors = []
+      begin
+        template = Liquid::Template.parse(value.to_s)
+        errors  += template.errors
+      rescue Exception => e
+        errors << e.message
+      end
+      for error in errors
+        record.errors.add(attr_name, friendly_liquid_error(error))
+      end
+    end
+  end
+  def validates_presence_of_liquid_variable(*attr_names)
+    configuration = { :message => I18n.translate('activerecord.errors.messages')[:invalid], :variable => nil, :container => nil }
+    configuration.update(attr_names.extract_options!)
+    raise(ArgumentError, "You must supply a variable to check for") if configuration[:variable].blank?
+    validates_each attr_names, configuration do |record, attr_name, value|
+      value         = value.to_s
+      variable      = configuration[:variable].to_s
+      variable_re   = /\{\{\s*#{ variable }( .*)?\}\}/
+      container     = configuration[:container].to_s
+      container_re  = /<\s*#{ container }.*>.*#{ variable_re }.*<\/\s*#{ container }\s*>/im
+      if container.blank? && !(value =~ variable_re)
+        record.errors.add(attr_name, "You must include {{ #{ variable } }} in your #{ friendly_attr_name(attr_name) }")
+      elsif !container.blank? && !(value =~ container_re)
+        record.errors.add(attr_name, "You must include {{ #{ variable } }} inside the <#{ container }> tag of your #{ friendly_attr_name(attr_name) }")
+      end
+    end
+  end
+  private
+  def friendly_attr_name(attr_name)
+    attr_name.to_s.humanize.downcase
+  end
+  def friendly_liquid_error(error)
+    error.gsub(/liquid/i, '').gsub(/terminated with regexp:.+/, 'closed')
+  end
+end
+ActiveRecord::Base.extend(LiquidValidations)

data/lib/liquid-validations/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module LiquidValidations
+  VERSION = '1.0.1'
+end

data/liquid-validations.gemspec ADDED Viewed

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'liquid-validations/version'
+Gem::Specification.new do |gem|
+  gem.name          = 'liquid-validations'
+  gem.version       = LiquidValidations::VERSION
+  gem.authors       = ['Matt Wigham', 'Joshua Abbott']
+  gem.email         = ['dev@bigcartel.com']
+  gem.description   = %q{ ActiveRecord style validations for Liquid content in your ActiveRecord models. See the README to get the lowdown. }
+  gem.summary       = %q{ ActiveRecord style validations for Liquid content in your ActiveRecord models. }
+  gem.homepage      = 'https://github.com/bigcartel/liquid-validations'
+  gem.license       = 'MIT'
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'liquid'
+  gem.add_dependency 'activerecord'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'minitest'
+end

data/spec/liquid_validations_spec.rb ADDED Viewed

@@ -0,0 +1,64 @@
+require 'spec_helper'
+class Mixin < ActiveRecord::Base
+end
+describe LiquidValidations do
+  it 'should provide the validates_liquid_of method to ActiveRecord subclasses' do
+    Mixin.must_respond_to(:validates_liquid_of)
+  end
+  it 'should provide the validates_presence_of_liquid_variable method to ActiveRecord subclasses' do
+    Mixin.must_respond_to(:validates_presence_of_liquid_variable)
+  end
+  describe '.validates_liquid_of' do
+    before do
+      Mixin.instance_eval do
+        validates_liquid_of :content
+      end
+      @mixin = Mixin.new
+    end
+    [ ' {{ Bad liquid ',
+      ' {% Bad liquid ',
+      '{% for %}{% endfor' ].each do |bad_liquid|
+      it "the record should be invalid when there is a liquid parsing error for #{ bad_liquid }" do
+        @mixin.content = bad_liquid
+        @mixin.valid?.must_equal false
+      end
+    end
+    it 'should include the errors in the errors object' do
+      @mixin.content = '{{ unclosed variable '
+      @mixin.valid?
+      @mixin.errors.must_include(:content)
+    end
+  end
+  describe '.validates_presence_of_liquid_variable' do
+    before do
+      Mixin.instance_eval do
+        validates_presence_of_liquid_variable :content, :variable => 'josh_is_awesome'
+      end
+      @mixin = Mixin.new
+    end
+    it 'must be configured properly' do
+      proc { Mixin.instance_eval { validates_presence_of_liquid_variable :content } }.must_raise ArgumentError
+    end
+    it 'the record should be invalid when the specified variable is not present' do
+      @mixin.content = '{{ josh_is_not_awesome }}'
+      @mixin.valid?.must_equal false
+    end
+    it 'should include the errors in the errors object' do
+      @mixin.content = '{{ josh_is_not_awesome }}'
+      @mixin.valid?
+      @mixin.errors.must_include(:content)
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,40 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rubygems'
+require 'active_record'
+require 'liquid'
+require 'liquid-validations'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => ':memory:', :database => 'liquid_validations_test.db')
+ActiveRecord::Migration.verbose = false
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :mixins do |t|
+      t.column :content, :text
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+  end
+end
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+class MiniTest::Spec
+  before do
+    setup_db
+  end
+  after do
+    teardown_db
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: liquid-validations
+version: !ruby/object:Gem::Version
+  hash: 21
+  prerelease:
+  segments:
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors:
+- Matt Wigham
+- Joshua Abbott
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00 -06:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency
+  name: minitest
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: " ActiveRecord style validations for Liquid content in your ActiveRecord models. See the README to get the lowdown. "
+email:
+- dev@bigcartel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/liquid-validations.rb
+- lib/liquid-validations/version.rb
+- liquid-validations.gemspec
+- spec/liquid_validations_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/bigcartel/liquid-validations
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.6.2
+signing_key:
+specification_version: 3
+summary: ActiveRecord style validations for Liquid content in your ActiveRecord models.
+test_files:
+- spec/liquid_validations_spec.rb
+- spec/spec_helper.rb