pattern_library 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbb8f45476b076d9e06304257cd93dc18008b05e
+  data.tar.gz: 8332fe702f3143838f76ad70cf563c1177a6d793
+SHA512:
+  metadata.gz: b3bffb790f7451b3465a8db89173be102234f5a991d37e2d9934531ad6118e591eee89fbefbbdc779b2ac3913d6fd11ac1b2c9c25da071321003ded8ed5e4b5d
+  data.tar.gz: f40f030dbb7204dc7d305d2b79ee8b6a0e1ad24d8047900347b0dbe17a2f0cfc975b88be13d69fdf97d28fbec3fe260b5c97ce6cb471c787545a098375e55a76

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,11 @@
+= PatternLibrary
+
+This project rocks and uses MIT-LICENSE.
+
+== Usage
+
+1. require gem
+1. mount engine in routes.rb: "mount PatternLibrary::Engine => "/pattern_library""
+1. copy migrations "rake pattern_library:install:migrations"
+1. load seeds: "PatternLibrary::Engine.load_seed"
+1. load css: *= require pattern_library/patterns

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PatternLibrary'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/pattern_library/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/pattern_library/patterns.js

@@ -0,0 +1,41 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+$(function() {
+  $('#pl-patterns .pl-pattern').each(function() {
+    var $this = $(this);
+    $this.find('.pl-snippet-styled > *').each(function() {
+      var styles = css($(this));
+      $(this).find('*').each(function() {
+        styles = styles.concat(css($(this)));
+      });
+      $this.find('.pl-pattern-css').text(prettyPrintArray(styles));
+    });
+  });
+});
+
+function css(a) {
+  var sheets = document.styleSheets, o = [];
+  for (var i in sheets) {
+    var rules = sheets[i].rules || sheets[i].cssRules;
+    for (var r in rules) {
+      if (a.is(rules[r].selectorText)) {
+        o.push(rules[r].cssText);
+      }
+    }
+  }
+  if (a.attr('style')) {
+    o.push("Inline { " + a.attr('style') + " }");
+  }
+  return o;
+}
+
+function prettyPrintArray(styles) {
+  return $.map(styles, function(rule) {
+    rule = rule.replace(/\{\s*/g, '{\n  ');
+    rule = rule.replace(/;\s*/g, ';\n  ');
+    rule = rule.replace(/([^;\s])\s*\}/g, '$1;\n}');
+    rule = rule.replace(/^\s+\}/gm, '}');
+    return rule;
+  }).join('\n');
+}

data/app/assets/stylesheets/pattern_library/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/pattern_library/patterns.css

@@ -0,0 +1,55 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+#pl-patterns {
+  border-top: 1px solid #333 !important;
+}
+
+#pl-patterns > .pl-pattern {
+  margin: 1em !important;
+  padding: 10px !important;
+  border-bottom: 1px solid #333 !important;
+}
+
+#pl-patterns > .pl-pattern .pl-pattern-html {
+  float: left;
+  width: 60%;
+  overflow: auto;
+}
+
+#pl-patterns > .pl-pattern .pl-pattern-css {
+  float: left;
+  width: 40%;
+  overflow: auto;
+  padding-left: 10px;
+  box-sizing: border-box;
+}
+
+#pl-patterns > .pl-pattern .pl-snippet-styled {
+  padding: 0 !important;
+  margin: 0 !important;
+  border: 1px solid #ccc !important;
+  position: relative !important;
+  overflow: hidden !important;
+}
+
+#pl-patterns > .pl-pattern .pl-actions {
+  clear: both;
+}
+
+#pl-patterns > .pl-pattern .pl-actions > * {
+  display: inline-block !important;
+  margin-top: 10px !important;
+}
+
+#pl-pattern-form .field, #pl-pattern-form .actions {
+  margin: 1em !important;
+}
+
+#pl-pattern-form label {
+  width: 125px !important;
+  display: inline-block !important;
+  vertical-align: top !important;
+}

data/app/controllers/pattern_library/application_controller.rb

@@ -0,0 +1,4 @@
+module PatternLibrary
+  class ApplicationController < ::ApplicationController
+  end
+end

data/app/controllers/pattern_library/patterns_controller.rb

@@ -0,0 +1,60 @@
+require_dependency "pattern_library/application_controller"
+
+module PatternLibrary
+  class PatternsController < ApplicationController
+    before_action :find_pattern, only: [:show, :edit, :update, :destroy]
+    before_action :protect_builtin, only: [:edit, :update, :destroy]
+
+    def index
+      @patterns = Pattern.all
+    end
+
+    def show
+    end
+
+    def new
+      @pattern = Pattern.new(order: Pattern.count)
+    end
+
+    def create
+      @pattern = Pattern.new pattern_params
+      if @pattern.save
+        redirect_to patterns_path, notice: 'Pattern created successfully'
+      else
+        flash.now[:alert] = @pattern.errors.full_messages.join('. ')
+        render :new
+      end
+    end
+
+    def edit
+    end
+
+    def update
+      if @pattern.update_attributes pattern_params
+        redirect_to patterns_path, notice: 'Pattern updated successfully'
+      else
+        flash.now[:alert] = @pattern.errors.full_messages.join('. ')
+        render :edit
+      end
+    end
+
+    def destroy
+      @pattern.destroy
+      redirect_to patterns_path, notice: 'Pattern deleted'
+    end
+
+    private
+
+    def find_pattern
+      @pattern = Pattern.find params[:id]
+    end
+
+    def protect_builtin
+      redirect_to patterns_path unless @pattern.custom?
+    end
+
+    def pattern_params
+      params.require(:pattern).permit :snippet, :usage, :order
+    end
+  end
+end

data/app/helpers/pattern_library/application_helper.rb

@@ -0,0 +1,4 @@
+module PatternLibrary
+  module ApplicationHelper
+  end
+end

data/app/helpers/pattern_library/patterns_helper.rb

@@ -0,0 +1,4 @@
+module PatternLibrary
+  module PatternsHelper
+  end
+end

data/app/models/pattern_library/pattern.rb

@@ -0,0 +1,9 @@
+module PatternLibrary
+  class Pattern < ActiveRecord::Base
+
+    default_scope { order :order }
+
+    validates_presence_of :snippet
+    validates_numericality_of :order, only_integer: true, greater_than_or_equal_to: 0
+  end
+end

data/app/views/pattern_library/patterns/_form.html.erb

@@ -0,0 +1,18 @@
+<div id="pl-pattern-form">
+  <%= form_for @pattern do |f| %>
+    <div class="field">
+      <%= f.label :snippet %>
+      <%= f.text_area :snippet, rows: 10, cols: 100 %>
+    </div>
+    <div class="field">
+      <%= f.label :usage, 'Usage (optional)' %>
+      <%= f.text_area :usage, rows: 10, cols: 100 %>
+    </div>
+    <%= f.hidden_field :order %>
+    <div class="actions">
+      <%= f.submit %>
+      |
+      <%= link_to 'Cancel', patterns_path %>
+    </div>
+  <% end %>
+</div>

data/app/views/pattern_library/patterns/_pattern.html.erb

@@ -0,0 +1,24 @@
+<div class="pl-pattern">
+  <div class="pl-pattern-html">
+    <pre class="pl-snippet"><%= pattern.snippet %></pre>
+    <div class="pl-snippet-styled">
+      <%= pattern.snippet.html_safe %>
+    </div>
+  </div>
+  <pre class="pl-pattern-css">
+  </pre>
+  <div class="pl-actions">
+    <% if pattern.usage.present? && !current_page?(pattern_path(pattern)) %>
+      <%= link_to 'Usage details', pattern_path(pattern) %>
+      <% if pattern.custom? %>
+        |
+      <% end %>
+    <% end %>
+    <% if pattern.custom? %>
+      <%= link_to 'Edit Pattern', edit_pattern_path(pattern) %> |
+      <%= form_for pattern, method: :delete do |f| %>
+        <%= f.submit 'Delete Pattern' %>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/views/pattern_library/patterns/edit.html.erb

@@ -0,0 +1,3 @@
+<h1>Edit Pattern</h1>
+
+<%= render 'form' %>

data/app/views/pattern_library/patterns/index.html.erb

@@ -0,0 +1,11 @@
+<h1>Patterns</h1>
+
+<div id="pl-patterns">
+  <% @patterns.each do |pattern| %>
+    <%= render pattern %>
+  <% end %>
+</div>
+
+<div id="pl-actions">
+  <p><%= link_to 'Create Pattern', new_pattern_path %></p>
+</div>

data/app/views/pattern_library/patterns/new.html.erb

@@ -0,0 +1,3 @@
+<h1>Create Pattern</h1>
+
+<%= render 'form' %>

data/app/views/pattern_library/patterns/show.html.erb

@@ -0,0 +1,13 @@
+<h1>Pattern</h1>
+
+<div id="pl-patterns">
+  <%= render @pattern %>
+  <h2>Usage</h2>
+  <div class="pl-pattern">
+    <%= @pattern.usage %>
+  </div>
+</div>
+
+<div id="pl-actions">
+  <p><%= link_to 'Back to list', patterns_path %></p>
+</div>

data/config/routes.rb

@@ -0,0 +1,5 @@
+PatternLibrary::Engine.routes.draw do
+  resources :patterns
+
+  root to: 'patterns#index'
+end

data/db/migrate/20140527235054_create_pattern_library_patterns.rb

@@ -0,0 +1,12 @@
+class CreatePatternLibraryPatterns < ActiveRecord::Migration
+  def change
+    create_table :pattern_library_patterns do |t|
+      t.string :snippet, null: false
+      t.text :usage, default: ''
+      t.integer :order, default: 0
+      t.boolean :custom, default: true
+
+      t.timestamps
+    end
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,65 @@
+PatternLibrary::Pattern.where(custom: false).delete_all
+
+order = -1
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<h1>Header One</h1>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<h2>Header Two</h2>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<h3>Header Three</h3>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<h4>Header Four</h4>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<h5>Header Five</h5>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<h6>Header Six</h6>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<p>Paragraph Text</p>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<p><a href="#">Link text</a></p>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<p><q>Inline Quotation</q></p>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<p><em>Emphasized</em> Paragraph Text</p>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: '<p><strong>Strong</strong> Paragraph Text</p>'
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: <<TABLE.strip_heredoc
+  <table>
+    <thead>
+      <tr>
+        <th>Header</th>
+        <th>Columns</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td>Body</td>
+        <td>Column</td>
+      </tr>
+      <tr>
+        <td>Body</td>
+        <td>Column</td>
+      </tr>
+    </tbody>
+  </table>
+TABLE
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: <<UL.strip_heredoc
+  <ul>
+    <li>Unordered</li>
+    <li>List</li>
+  </ul>
+UL
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: <<OL.strip_heredoc
+  <ol>
+    <li>Ordered</li>
+    <li>List</li>
+  </ol>
+OL
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: <<DL.strip_heredoc
+  <dl>
+    <dt>Definition Term 1</dt>
+    <dd>Definition Description 1</dd>
+    <dt>Definition Term 2</dt>
+    <dd>Definition Description 2</dd>
+  </dl>
+DL
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: <<BQ.strip_heredoc
+  <blockquote>
+    Better to remain silent and be thought a fool than to speak out and remove all doubt.
+  </blockquote>
+BQ
+PatternLibrary::Pattern.create order: order += 1, custom: false, snippet: <<FIG.strip_heredoc
+  <figure>
+    <img src="http://f.cl.ly/items/1x3y251R0W0m1u02421z/Image%202014-02-21%20at%204.50.36%20PM.png" alt="high usage">
+    <figcaption>Figure wrapping an image with caption</figcaption>
+  </figure>
+FIG