locomotive_plugins 1.0.0.beta2

data/spec/lib/locomotive/plugin_spec.rb

@@ -0,0 +1,46 @@
+
+require 'spec_helper'
+
+module Locomotive
+  describe Plugin do
+
+    before(:each) do
+      @config = {}
+      @plugin = MyPlugin.new(@config)
+      @useless_plugin = UselessPlugin.new(@config)
+    end
+
+    it 'should call custom initialization methods' do
+      @plugin.custom_attribute.should == 'Value'
+    end
+
+    it 'should store a list of before_filters' do
+      @plugin.before_filters.count.should == 2
+      @plugin.before_filters[0].should == :my_method1
+      @plugin.before_filters[1].should == :my_method2
+    end
+
+    it 'should have an empty array of before_filters by default' do
+      @useless_plugin.before_filters.should == []
+    end
+
+    it 'should optionally return a liquid drop' do
+      @plugin.to_liquid.class.should == MyPlugin::MyDrop
+      @useless_plugin.to_liquid.should be_nil
+    end
+
+    it 'should optionally return liquid filters' do
+      MyPlugin.liquid_filters.should == MyPlugin::Filters
+      UselessPlugin.liquid_filters.should be_nil
+    end
+
+    it 'should optionally return liquid tags' do
+      MyPlugin.liquid_tags.should == {}
+      PluginWithTags.liquid_tags.should == {
+        :paragraph => PluginWithTags::Paragraph,
+        :newline => PluginWithTags::Newline
+      }
+    end
+
+  end
+end

data/spec/lib/locomotive_plugins_spec.rb

@@ -0,0 +1,29 @@
+
+require 'spec_helper'
+
+describe LocomotivePlugins do
+
+  before(:each) do
+    LocomotivePlugins.clear_registered_plugins
+  end
+
+  it 'should register plugins under a given id' do
+    LocomotivePlugins.register_plugin(Locomotive::MyPlugin, 'my_amazing_plugin')
+    registered = LocomotivePlugins.registered_plugins
+    registered.count.should == 1
+    registered['my_amazing_plugin'].should == Locomotive::MyPlugin
+  end
+
+  it 'should register plugins under the default id' do
+    default_id = LocomotivePlugins.default_id(Locomotive::MyPlugin)
+    LocomotivePlugins.register_plugin(Locomotive::MyPlugin)
+    registered = LocomotivePlugins.registered_plugins
+    registered.count.should == 1
+    registered[default_id].should == Locomotive::MyPlugin
+  end
+
+  it 'should use the underscorized class name without any modules as the default id' do
+    LocomotivePlugins.default_id(Locomotive::MyPlugin).should == 'my_plugin'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+
+require 'rubygems'
+require 'bundler'
+
+require 'rspec'
+
+require 'factory_girl'
+require 'database_cleaner'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'locomotive_plugins'
+
+# Set up mongoid
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('locomotive_plugins_test')
+end
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+
+   # Use color in STDOUT
+  config.color_enabled = true
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.orm = 'mongoid'
+  end
+
+  config.before(:each) do
+    Mongoid::IdentityMap.clear
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.clean
+  end
+
+  config.after(:suite) do
+    DatabaseCleaner.clean
+  end
+
+end

data/spec/support/factories.rb

@@ -0,0 +1,3 @@
+FactoryGirl.define do
+
+end

data/spec/support/plugins/my_other_plugin.rb

@@ -0,0 +1,16 @@
+
+module Locomotive
+  class MyOtherPlugin
+    include Locomotive::Plugin
+
+    before_filter :another_method
+
+    def config_template_file
+      File.join(File.dirname(__FILE__), '..', '..', 'fixtures',
+        'config_template.haml')
+    end
+
+    def another_method
+    end
+  end
+end

data/spec/support/plugins/my_plugin.rb

@@ -0,0 +1,42 @@
+
+module Locomotive
+  class MyPlugin
+    include Locomotive::Plugin
+
+    module Filters
+    end
+
+    class MyDrop < ::Liquid::Drop
+    end
+
+    before_filter :my_method1
+    before_filter :my_method2
+
+    attr_accessor :custom_attribute
+
+    def initialize_plugin
+      self.custom_attribute = 'Value'
+    end
+
+    def to_liquid
+      MyDrop.new
+    end
+
+    def config_template_file
+      File.join(File.dirname(__FILE__), '..', '..', 'fixtures',
+        'config_template.html')
+    end
+
+    def self.liquid_filters
+      Filters
+    end
+
+    def my_method1
+      'This is my first before filter!'
+    end
+
+    def my_method2
+      'This is my second before filter!'
+    end
+  end
+end

data/spec/support/plugins/plugin_with_db_model.rb

@@ -0,0 +1,19 @@
+
+module Locomotive
+  class PluginWithDBModel
+    include Locomotive::Plugin
+
+    class VisitCount < Locomotive::Plugin::DBModel
+      field :count, default: 0
+    end
+
+    class Item < Locomotive::Plugin::DBModel
+      field :name
+      validates_presence_of :name
+    end
+
+    has_one :visit_count, VisitCount
+    has_many :items, Item
+
+  end
+end

data/spec/support/plugins/plugin_with_filter.rb

@@ -0,0 +1,21 @@
+
+module Locomotive
+  class PluginWithFilter
+    include Locomotive::Plugin
+
+    module Filters
+      def add_http(input)
+        if input.start_with?('http://')
+          input
+        else
+          "http://#{input}"
+        end
+      end
+    end
+
+    def self.liquid_filters
+      Filters
+    end
+
+  end
+end

data/spec/support/plugins/plugin_with_many_filter_modules.rb

@@ -0,0 +1,23 @@
+
+module Locomotive
+  class PluginWithManyFilterModules
+    include Locomotive::Plugin
+
+    module Filters
+      def add_newline(input)
+        "#{input}\n"
+      end
+    end
+
+    module MoreFilters
+      def remove_http(input)
+        input.sub(%r{^http://}, '')
+      end
+    end
+
+    def self.liquid_filters
+      [ Filters, MoreFilters ]
+    end
+
+  end
+end

data/spec/support/plugins/plugin_with_non_string_path.rb

@@ -0,0 +1,23 @@
+
+module Locomotive
+  class PluginWithNonStringPath
+
+    include Locomotive::Plugin
+
+    class Pathname
+      def initialize(path)
+        @path = path
+      end
+
+      def to_s
+        @path.to_s || ''
+      end
+    end
+
+    def config_template_file
+      Pathname.new(File.join(File.dirname(__FILE__), '..', '..', 'fixtures',
+        'config_template.html'))
+    end
+
+  end
+end

data/spec/support/plugins/plugin_with_tags.rb

@@ -0,0 +1,31 @@
+
+module Locomotive
+  class PluginWithTags
+
+    include Locomotive::Plugin
+
+    class Paragraph < ::Liquid::Block
+      def render(context)
+        "<p>#{render_all(@nodelist, context)}</p>"
+      end
+
+      def render_disabled(context)
+        render_all(@nodelist, context)
+      end
+    end
+
+    class Newline < ::Liquid::Tag
+      def render(context)
+        "<br />"
+      end
+    end
+
+    def self.liquid_tags
+      {
+        :paragraph => Paragraph,
+        :newline => Newline
+      }
+    end
+
+  end
+end

data/spec/support/plugins/useless_plugin.rb

@@ -0,0 +1,6 @@
+
+module Locomotive
+  class UselessPlugin
+    include Locomotive::Plugin
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: locomotive_plugins
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta2
+  prerelease: 6
+platform: ruby
+authors:
+- Colibri Software
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: locomotive_liquid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.12
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem allows developers to create plugins for Locomotive CMS with
+  particular functionality. See the README for more details
+email: info@colibri-software.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/locomotive/plugin/db_model_container.rb
+- lib/locomotive/plugin/liquid.rb
+- lib/locomotive/plugin/liquid/prefixed_filter_module.rb
+- lib/locomotive/plugin/liquid/tag_subclass_methods.rb
+- lib/locomotive/plugin/db_models.rb
+- lib/locomotive/plugin/db_model.rb
+- lib/locomotive/plugin/config_ui.rb
+- lib/locomotive/plugin.rb
+- lib/version.rb
+- lib/locomotive_plugins.rb
+- spec/spec_helper.rb
+- spec/support/plugins/my_other_plugin.rb
+- spec/support/plugins/plugin_with_non_string_path.rb
+- spec/support/plugins/plugin_with_tags.rb
+- spec/support/plugins/useless_plugin.rb
+- spec/support/plugins/plugin_with_filter.rb
+- spec/support/plugins/plugin_with_many_filter_modules.rb
+- spec/support/plugins/my_plugin.rb
+- spec/support/plugins/plugin_with_db_model.rb
+- spec/support/factories.rb
+- spec/fixtures/config_template.haml
+- spec/fixtures/config_template.html
+- spec/lib/locomotive/plugin/liquid_spec.rb
+- spec/lib/locomotive/plugin/db_models_spec.rb
+- spec/lib/locomotive/plugin/config_ui_spec.rb
+- spec/lib/locomotive/plugin_spec.rb
+- spec/lib/locomotive_plugins_spec.rb
+- README.md
+- CHANGELOG
+homepage: https://github.com/colibri-software/locomotive_plugins
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gem for creating plugins for Locomotive
+test_files: []