middleman-cta 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43aacba735c49bff1a1ea2c8bd11fed95dd1687b
+  data.tar.gz: 17fbd341da86f1cfcb872fda91d97120bc984e40
+SHA512:
+  metadata.gz: 8bcc4b6a4ce83b9c63922a5eaad40a001cae5782498f82ef37c5271c74566cbe6c571797572bc69b1e182df6f18a5e735ebd39e14f4c6d7999a296faec01fe68
+  data.tar.gz: 0f79ae47d426e781a73951c6d276c4308dc28c174a2398c7a9639b5b9ff37b42570e56b56c35092d1834a2a93566b39f775619f003991e1a272b5a5db370c525

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-cta.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,58 @@
+# middleman-cta
+
+Provides an easy way to define CTAs in your project using a data file and defined structure.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'middleman-cta'
+```
+
+Then run bundle.
+
+```
+$> bundle install
+```
+
+## Usage
+
+In your `data/cta.yml` (or JSON):
+
+```yaml
+-
+  id: great-cta
+  image: name-of-file-in-cta-image-dir.jpg
+  url: "http://absolute.url"
+```
+
+## Configuration
+You can configure the name of the data file, as well as the directory in which the images are stored.
+
+```ruby
+activate :cta do |cta|
+  cta.cta_directory = 'cta_images'
+  cta.cta_data = 'call_to_actions'
+end
+```
+
+## Rendering
+
+We support two template engines by default, ERB and Markdown.  For Markdown support, we currently only support Redcarpet as the markdown engine.
+
+
+### ERB
+You have access to a helper method to use in ERB:
+
+```ruby
+<h2>Signup Now</h2>
+<%= cta('unique-cta-id') %>
+```
+
+### Markdown
+
+```markdown
+## Signup Now
+[cta:unique-cta-id]
+```

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/clean'

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-cta')

data/lib/cta/extension.rb

@@ -0,0 +1,46 @@
+module CTA
+  class Extension < ::Middleman::Extension
+    option :cta_directory, 'cta', 'Directory containing your CTA images'
+    option :cta_data, 'cta', 'Details of each CTA in YML or JSON format'
+
+    def initialize(app, options_hash={}, &block)
+      super
+    end
+
+    def after_configuration
+       app.logger.info("== CTA: #{ options.cta_data } is not a valid data key") unless app.data.key?(options.cta_data)
+
+       if app.config[:markdown_engine] == :redcarpet
+         require 'middleman-core/renderers/redcarpet'
+         Middleman::Renderers::MiddlemanRedcarpetHTML.send(:include, CTA::Redcarpet::CTARenderer)
+       end
+    end
+
+    def cta_datasource
+      app.data[options.cta_data]
+    end
+
+    def find_cta(id)
+      attributes = cta_datasource.find { |cta| cta[:id] == id }
+      raise "Unable to locate CTA[#{ id }]" if attributes.blank?
+
+      Instance.new(attributes)
+    end
+
+    helpers do
+      def cta_controller
+        app.extensions[:cta]
+      end
+
+      def cta(id, options={})
+        result = cta_controller.find_cta(id)
+
+        options[:class] ||= 'cta-image'
+
+        link_to result.url, class: 'cta-link' do
+          image_tag(File.join(cta_controller.options.cta_directory, result.image), options)
+        end
+      end
+    end
+  end
+end

data/lib/cta/instance.rb

@@ -0,0 +1,11 @@
+module CTA
+  class Instance
+    attr_accessor :image, :url, :id
+
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        self.public_send("#{ key }=", value)
+      end
+    end
+  end
+end

data/lib/cta/redcarpet/cta_renderer.rb

@@ -0,0 +1,17 @@
+module CTA
+  module Redcarpet
+    module CTARenderer
+      TAG_REGEX = %r{\[cta:([^\]]+)\]}.freeze
+
+      def preprocess(full_document)
+        full_document.gsub! TAG_REGEX do |text|
+          match_data = text.match(TAG_REGEX)
+
+          scope.cta(match_data[1])
+        end
+
+        full_document
+      end
+    end
+  end
+end

data/lib/middleman-cta.rb

@@ -0,0 +1,9 @@
+require "middleman-core"
+
+Middleman::Extensions.register :cta do
+  require 'cta/instance'
+  require 'cta/redcarpet/cta_renderer'
+  require 'cta/extension'
+
+  CTA::Extension
+end

data/middleman-cta.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-cta"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matt Millsaps-Brewer"]
+  s.email       = ["matt@madebylotus.com"]
+  s.homepage    = "http://www.madebylotus.com"
+  s.summary     = %q{Provides a consistent Call-To-Action helper}
+  s.description = %q{Easily insert CTA campaigns into your post, including markdown}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 4.0.0"])
+
+  # Additional dependencies
+  # s.add_runtime_dependency("gem-name", "gem-version")
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: middleman-cta
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Millsaps-Brewer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Easily insert CTA campaigns into your post, including markdown
+email:
+- matt@madebylotus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/cta/extension.rb
+- lib/cta/instance.rb
+- lib/cta/redcarpet/cta_renderer.rb
+- lib/middleman-cta.rb
+- middleman-cta.gemspec
+homepage: http://www.madebylotus.com
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Provides a consistent Call-To-Action helper
+test_files:
+- features/support/env.rb