middleman-patterns 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5e5479560dfbf3d84ba888602e12ef1d9ff462b
+  data.tar.gz: e44d850b59e9100f7216d093ae66fa7359076baf
+SHA512:
+  metadata.gz: e68baa7075ae06f5b94fd5aa663c21747abdf70a181008c150b850fa23f8063cf558c4b58c0a2fb252c54bd45d68974fac5258657e3a30a78522233fdfdbb10c
+  data.tar.gz: 413b5d771c5ffdf978e223ea65d3e18e4c41f37ecd05f4931dc519e8b2bedb892dec46a096b2c53a078d4e968679be2690f1084be9909097eacc8588c0e76fb4

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/Encoding:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 100
+
+Style/FileName:
+  Enabled: false
+  Exclude: 'lib/middleman-patterns.rb'
+
+Style/SignalException:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+# 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-patterns.gemspec
+gemspec
+
+group :development do
+  gem 'yard', '~> 0.8.7'
+end
+
+group :test do
+  gem 'rubocop', '~> 0.28'
+  gem 'simplecov', '~> 0.9' require: false
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bearded
+
+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,83 @@
+# Pattern Man
+A middleman extension that implements [Pattern Lab-style](http://patternlab.io) patterns.
+
+### Installation
+
+You'll need to install this gem first.
+
+* put `gem install 'middleman-patterns'` in the Gemfile of your middleman project
+* run `bundle install`
+* add `activate :patterns` to your `config.rb` file outside the `configure :build` block
+       
+
+You're up and running! This gem supports whatever templating engines middleman supports, but you do need to put the template files for patterns where this extension can find them. The expected default directory structure looks like the following (filenames are examples):
+
+```
+source/
+  patterns/
+    templates/
+      user-information.html.erb
+    organisms/
+      address-input.html.erb
+    molecules/
+      labeled-input.html.erb
+    atoms/
+      button.html.erb
+```
+
+### Using Patterns
+
+Put some HTML in your patterns:
+
+```html+ruby
+# patterns/molecules/labeled-input.html.erb
+---
+input_class: 'input'
+---
+
+<div class="<%=input_class%>">
+  <label for="<%=input_id%>">
+    <%= label_text %>
+  </label>
+  <%= atom 'input' %>
+</div>
+```
+
+```html+ruby
+# patterns/atoms/input.html.erb
+---
+input_type: text
+---
+<input type="<%= input_type %>" <% if input_id %> id="<%= input_id %>" <% end %>>
+```
+
+Then use the appropriate helper method in your middleman view:
+
+```html+ruby
+# source/index.html.erb
+
+<div class="welcome">
+  <%= molecule 'labeled-input', input_id: 'some_input', label_text: "Fill me out!" %>
+</div>
+```
+
+And your output will be:
+
+```html
+<div class="welcome">
+  <div class="input">
+    <label for="some_input">
+      Fill me out!
+    </label>
+    <input type="text"  id="some_input">
+  </div>
+</div>
+```
+
+### Config options
+
+You can customize the patterns directory by passing `patterns_directory: 'other_directory'` when activating the extension.
+
+By default, this extension ignores everything in the `patterns` directory when building the site, so you don't end up with pages with URLs like `/patterns/atoms/button.html`. You can override this so that the site *does* build these pages if you want, by passing the `build_patterns` option.
+
+`activate :patterns, build_patterns: true`

data/Rakefile

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/lib/middleman-patterns/helpers.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+module Middleman
+  module Patterns
+    # These helpers are available in source template files.
+    #
+    # Helpers are defined dynamically to match the pattern types in the
+    # PATTERNS constant.
+    #
+    # These pattern calls all work identically except for the path the extension
+    # checks for the source file (based on pattern type).
+    #
+    # Variables are available in patterns and can come from one of three places:
+    #
+    # * Front matter in the pattern file itself
+    # * locals passed to the pattern
+    # * locals that were passed into the currently-rendering pattern
+    #
+    # @example Nested Patterns
+    #
+    # Given the following two patterns for a button:
+    #
+    #    # patterns/molecules/buttons.html.erb
+    #    ---
+    #    div_class: 'button'
+    #    ---
+    #    <div class="<%= div_class %>">
+    #      <%= atom 'button', button_text: 'molecule button' %>
+    #    </div>
+    #
+    #    --------------------------
+    #
+    #    # patterns/atoms/button.html.erb
+    #    ---
+    #    button_text: I'm a button
+    #    ---
+    #
+    #    <button type="button"><%= button_text %></button>
+    #
+    #
+    # Variable precendence flows from highest->lowest pattern in terms of nesting,
+    # so a molecule with a local passed which is the same name as application data
+    # variable or front-matter variable will be overridden (div_class above).
+    #
+    #    # index.html.erb
+    #    <%= molecule 'buttons', div_class: 'big-button' %>
+    #    <%= molecule 'buttons', button_text: "Send 1000 emails" %>
+    #
+    # Should render:
+    #
+    #    <div class="big-button">
+    #      <button type="button">molecule button</button>
+    #    </div>
+    #
+    #    <div class="button">
+    #      <button type="button">Send 1000 emails</button>
+    #    </div>
+    #
+    # @see PATTERNS
+    module Helpers
+      PATTERNS = %w(template organism molecule atom)
+
+      # Getter for locals passed into pattern calls.
+      # Allows scoping for variables for nested pattern rendering
+      #
+      # Example: Rendering a molecule template that renders a "Label" atom:
+      #
+      # Calling as `molecule 'labeled-input', label_class: 'optional'`
+      # will override the atom's label_class local, even though in the molecule's template
+      # the label atom will be called without explicitly setting the label_class.
+      #
+      # @return [Hash]
+      def context_variables
+        @context_variables ||= {}
+        @context_variables
+      end
+
+      PATTERNS.each do |type|
+        # define helper methods available to templates. They all have the same signature.
+        define_method type do |name, locals = {}, context = self|
+          path = resolve_pattern_path(type, name)
+
+          # keep a copy of our old state
+          old_context = context_variables.dup
+
+          # update our state
+          update_context locals, extensions[:frontmatter].data(path).first
+
+          # render the file (including potentially recursively other patterns)
+          output = render_individual_file(path, context_variables, {}, context)
+
+          # restore our state pre-call
+          @context_variables = old_context
+
+          output
+        end
+      end
+
+      # Get the path to the specified pattern on disk. This respects the config setting
+      # patterns_directory to determine where to look.
+      #
+      # @see {PatternsExtension#patterns_directory}
+      # @param [String] pattern_type The type of pattern
+      # @param [String] pattern_name The name of the pattern (without file extension)
+      # @return [String] The absolute path to the specified pattern on disk.
+      def resolve_pattern_path(pattern_type, pattern_name)
+        path = File.join(config.patterns_directory, pattern_type.pluralize, pattern_name)
+        absolute_path = resolve_template(path)
+
+        unless absolute_path
+          error_message = "#{pattern_type.capitalize} #{pattern_name} not found: #{path}"
+          raise ::Middleman::CoreExtensions::Rendering::TemplateNotFound, error_message
+        end
+
+        absolute_path
+      end
+
+      private
+
+      # Update the contextual variables from the parent pattern
+      #
+      # This handles setting priority between frontmatter data,
+      # locals passed when rendering, and locals passed from the parent pattern.
+      # @param locals [Hash] A set of locals
+      # @return [Mixed]
+      def update_context(locals = {}, frontmatter = {})
+        # This is our currently-passed context
+        old_context = context_variables.dup
+
+        # Override front-matter data with locals
+        new_context = frontmatter.merge(locals)
+
+        # Override the result with anything passed from a higher level
+        @context_variables = new_context.merge(old_context)
+      end
+    end
+  end
+end

data/lib/middleman-patterns.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'middleman-core'
+require 'middleman-patterns/helpers'
+
+# Middleman extension class.
+# Allows overriding default patterns' directory.
+# Exposes helper methods in helpers.rb to templates in the middleman app.
+# Ignores the patterns directory when building the site by default.
+#
+# Options:
+#    :patterns_directory
+#      the local directory patterns are stored in, defaults to "patterns"
+#
+#    :build_patterns
+#      whether or not to ignore the patterns directory when building the site
+#
+# @see Middleman::Patterns::Helpers
+class PatternsExtension < ::Middleman::Extension
+  option :patterns_directory, 'patterns', 'The location of the patterns\' directory'
+  option :build_patterns, false, 'Whether or not to build pages for patterns.'
+
+  self.defined_helpers = [Middleman::Patterns::Helpers]
+
+  def initialize(app, options_hash = {}, &block)
+    super
+
+    app.set :patterns_directory, options.patterns_directory
+  end
+
+  # Handles ignoring the patterns directory during build if this appropriate option is set.
+  def after_configuration
+    @app.ignore(/#{app.config.setting(:patterns_directory).value}\//) unless options.build_patterns
+  end
+end
+
+PatternsExtension.register(:patterns)

data/lib/middleman_extension.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'middleman-patterns'

data/middleman-patterns.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-patterns'
+  s.version     = '0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Brett Bender']
+  s.email       = ['brett@bearded.com']
+  s.homepage    = 'http://www.bearded.com'
+  s.summary     = 'An implementation of pattern-lab (http://patternlab.io) for middleman'
+  s.description = s.summary
+
+  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']
+
+  s.licenses      = ['MIT']
+
+  s.add_runtime_dependency 'middleman-core', ['~> 3.3', '>= 3.3.7']
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: middleman-patterns
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Brett Bender
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.7
+description: An implementation of pattern-lab (http://patternlab.io) for middleman
+email:
+- brett@bearded.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/middleman-patterns.rb
+- lib/middleman-patterns/helpers.rb
+- lib/middleman_extension.rb
+- middleman-patterns.gemspec
+homepage: http://www.bearded.com
+licenses:
+- MIT
+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.4.2
+signing_key: 
+specification_version: 4
+summary: An implementation of pattern-lab (http://patternlab.io) for middleman
+test_files: []