great_pretender 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d7bef2a3f4eedc66d221d827f8a6f747cb54b4c
+  data.tar.gz: 4e36bcc3085b77217e178240f1e6aa22098dfc52
+SHA512:
+  metadata.gz: a2a4192ad7d8997fb34aad458289b6a189ca99b3d31b8f1f21bf8e6fd2fab7bf027b965192a275b335adf6faa179ded3016de479e53bd1447314e62332b88444
+  data.tar.gz: f9f15adcb02f5466ee6447267e2c00374bf2a839943a90726e6677ea4cfd17f8ffe2ab630e742f1a2bc2e9ae020c19071d234732981a6acbcf2374c7c8eb278d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Flip Sasser
+
+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

@@ -0,0 +1,31 @@
+# GreatPretender
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'great_pretender'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install great_pretender
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/great_pretender/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/great_pretender/mockups_controller.rb

@@ -0,0 +1,9 @@
+require 'great_pretender/controller'
+
+module GreatPretender
+  class MockupsController < ::ApplicationController
+
+    include GreatPretender::Controller
+
+  end
+end

data/app/helpers/great_pretender/mockups_helper.rb

@@ -0,0 +1,29 @@
+module GreatPretender
+  module MockupsHelper
+
+    def great_pretender_mockup_path(mockup)
+      if controller.is_a?(GreatPretender::MockupsController)
+        great_pretender_engine.mockup_path(mockup)
+      else
+        path_helper = controller_path.split("/")
+        path_helper = path_helper.join("_")
+        path_helper = path_helper.singularize
+        path_helper << '_url'
+        begin
+          send(path_helper, mockup)
+        rescue NoMethodError => error
+          error_message_subs = [controller_path, path_helper]
+          error_message = I18n.t('great_pretender.missing_helper_methods') % error_message_subs
+          raise MissingPathHelperError.new(error_message, error)
+        end
+      end
+    end
+  end
+
+  class MissingPathHelperError < StandardError
+    def initialize(message, error)
+      super(message)
+      @original_error = error
+    end
+  end
+end

data/app/views/great_pretender/index.html.erb

@@ -0,0 +1,30 @@
+<% if mockups.any? %>
+  <table id="mockups">
+    <thead>
+      <tr>
+        <th>Template</th>
+        <th>Last Updated</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% mockups.each do |mockup| %>
+        <tr>
+          <td>
+            <strong>
+              <%= link_to mockup.name, great_pretender_mockup_path(mockup) %>
+            </strong>
+          </td>
+          <td>
+            <%= time_ago_in_words(mockup.updated_at) %> ago
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <p>
+    No mockups found. Add a template file to <code><%= mockup_root %></code> to
+    see it listed here.
+  </p>
+<% end %>
+

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  great_pretender:
+    missing_helper_methods: "Great Pretender couldn't find a path helper to a mockup from %s. I tried '%s' to no avail. Have you named your mockup routes?"
+    not_found: "No mockup found at %s"

data/config/routes.rb

@@ -0,0 +1,4 @@
+GreatPretender::Engine.routes.draw do
+  root to: 'great_pretender/mockups#index', as: :mockups
+  get '*id', to: 'great_pretender/mockups#show', as: :mockup
+end

data/great_pretender.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'great_pretender/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "great_pretender"
+  spec.version       = GreatPretender::VERSION
+  spec.authors       = ["Flip Sasser"]
+  spec.email         = ["flip@inthebackforty.com"]
+  spec.summary       = %q{Ridiculously easy-to-use Rails mockups for those enlightened individuals who design in-browser}
+  spec.description   = %q{Use Great Pretender to easily add layout-specific mockups in a Rails app without having to recreate the mockup wheel. Your design should be happening in-browser; this will help you get there.}
+  spec.homepage      = "https://github.com/BackForty/great_pretender"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/great_pretender/config.rb

@@ -0,0 +1,21 @@
+module GreatPretender
+
+  class Config
+    attr_accessor :default_layout, :path_separator, :view_path
+  end
+
+  def self.config
+    @config ||= Config.new
+    if block_given?
+      yield @config
+    end
+    @config
+  end
+
+end
+
+GreatPretender.config do |c|
+  c.default_layout = 'application'
+  c.path_separator = ' > '
+  c.view_path = 'mockups'
+end

data/lib/great_pretender/controller.rb

@@ -0,0 +1,45 @@
+require "great_pretender/mockup_locator"
+
+module GreatPretender
+  module Controller
+
+    def self.included(base)
+      base.helper_method :mockup
+      base.helper_method :mockups
+      base.helper_method :mockup_root
+      base.helper GreatPretender::MockupsHelper
+    end
+
+    def index
+      render template: 'great_pretender/index'
+    end
+
+    def show
+      if mockup
+        render template: mockup.template, layout: mockup.layout
+      else
+        error_message = I18n.t('great_pretender.not_found') % params[:id]
+        raise ActiveRecord::RecordNotFound.new(error_message)
+      end
+    end
+
+    private
+
+    def mockup
+      @great_pretender_mockup ||= mockup_locator.find(params[:id])
+    end
+
+    def mockups
+      @great_pretender_mockups ||= mockup_locator.mockups
+    end
+
+    def mockup_locator
+      @great_pretender_mockup_locator ||= MockupLocator.new(view_paths)
+    end
+
+    def mockup_root
+      @great_pretender_mockup_root ||= mockup_locator.view_paths.first.join(GreatPretender.config.view_path)
+    end
+
+  end
+end

data/lib/great_pretender/engine.rb

@@ -0,0 +1,4 @@
+module GreatPretender
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/great_pretender/mockup.rb

@@ -0,0 +1,29 @@
+require "active_support/core_ext/string/inflections"
+require "great_pretender/config"
+
+module GreatPretender
+  class Mockup
+
+    attr_accessor :layout, :slug, :template
+
+    alias :to_param :slug
+
+    def initialize(path)
+      @file = Pathname.new(path)
+    end
+
+    def name
+      return @name if defined? @name
+      name = slug.split('/').map { |s| s.titleize }.join(GreatPretender.config.path_separator)
+      if slug =~ /^_/
+        name << ' (partial)'
+      end
+      @name = name
+    end
+
+    def updated_at
+      @file.mtime
+    end
+
+  end
+end

data/lib/great_pretender/mockup_locator.rb

@@ -0,0 +1,87 @@
+require "great_pretender/config"
+require "great_pretender/mockup"
+
+module GreatPretender
+  class MockupLocator
+
+    attr_reader :view_paths
+
+    def find(slug)
+      mockups.find {|mockup| mockup.slug == slug}
+    end
+
+    def mockups
+      return @mockups if defined? @mockups
+      mockups = []
+      @view_paths.each do |view_path|
+        root = view_path.join(GreatPretender.config.view_path)
+        templates = Dir[root.join("**/*.#{extensions}")]
+        templates.each do |path|
+          mockup = Mockup.new(path)
+          mockup.slug = slug_for(root, path)
+          mockup.layout = layout_for(mockup.slug)
+          mockup.template = template_for(view_path, root, mockup.slug)
+          mockups.push(mockup)
+        end
+      end
+      @mockups = mockups
+    end
+
+    def initialize(view_paths)
+      @view_paths = view_paths.map do |view_path|
+        if view_path.is_a?(Pathname)
+          view_path
+        elsif view_path.respond_to?(:to_path)
+          Pathname.new(view_path.to_path)
+        else
+          Pathname.new(view_path.to_s)
+        end
+      end
+    end
+
+    private
+
+    def extensions
+      return @extensions if defined? @extensions
+      extensions = ActionView::Template.template_handler_extensions
+      extensions = extensions.map(&:to_s).join(',')
+      @extensions = "{#{extensions}}"
+    end
+
+    def layout_for(slug)
+      if File.basename(slug) =~ /^_/
+        # Partials (named like "_template_name") don't render inside a layout.
+        # This way they can be used w/Ajax requests, etc.
+        nil
+      else
+        # Mockups can have a layout by being in a folder named after that
+        # layout; for example, "app/views/mockups/admin/index" will look for an
+        # "admin" template
+        layout = slug.split('/').first
+        if layout && layout.length > 0
+          @view_paths.each do |view_path|
+            layout_path = view_path.join('layouts')
+            layout_path = layout_path.join("#{layout}.*#{extensions}")
+            puts "\n\n\n" + layout_path.inspect + "\n\n\n"
+            return layout if Dir[layout_path].any?
+          end
+        end
+        GreatPretender.config.default_layout
+      end
+    end
+
+    def slug_for(root, path)
+      slug = path.to_s.gsub(%r{^#{root.to_s}/}, '')
+      while (ext = File.extname(slug)).length > 0
+        slug = slug.gsub(/#{ext}$/, '')
+      end
+      slug
+    end
+
+    def template_for(view_path, root, slug)
+      template_root = root.relative_path_from(view_path)
+      template_root.join(slug).to_s
+    end
+
+  end
+end

data/lib/great_pretender/version.rb

@@ -0,0 +1,3 @@
+module GreatPretender
+  VERSION = "0.0.1"
+end

data/lib/great_pretender.rb

@@ -0,0 +1,8 @@
+require "great_pretender/config"
+require "great_pretender/controller"
+require "great_pretender/version"
+
+module GreatPretender
+end
+
+require "great_pretender/engine" if defined? Rails

data/spec/lib/great_pretender/config_spec.rb

@@ -0,0 +1,37 @@
+module GreatPretender; end
+
+describe GreatPretender do
+
+  context ".config" do
+
+    before { load("great_pretender/config.rb") }
+
+    context "default configuration values" do
+
+      it "has 'application' as the default layout" do
+        expect(GreatPretender.config.default_layout).to eq("application")
+      end
+
+      it "has 'mockups' as the default view path" do
+        expect(GreatPretender.config.view_path).to eq("mockups")
+      end
+
+    end
+
+    it "accepts a block" do
+      GreatPretender.config do |c|
+        c.default_layout = "another_layout"
+        c.view_path = "somewhere"
+      end
+      expect(GreatPretender.config.default_layout).to eq("another_layout")
+      expect(GreatPretender.config.view_path).to eq("somewhere")
+    end
+
+    it "can be used for direct setting of configuration options" do
+      GreatPretender.config.default_layout = "a_third_layout"
+      expect(GreatPretender.config.default_layout).to eq("a_third_layout")
+    end
+
+  end
+
+end

data/spec/lib/great_pretender/mockup_locator_spec.rb

@@ -0,0 +1,52 @@
+require 'great_pretender/mockup_locator'
+require 'pathname'
+require_relative '../../support/mockup_helpers'
+
+module ActionView
+  module Template
+    def self.template_handler_extensions
+      %w(erb slim haml)
+    end
+  end
+end
+
+describe GreatPretender::MockupLocator do
+
+  include MockupHelpers
+
+  let(:regular_mockup) { mockup_locator.mockups.find {|m| m.slug =~ /^processed/ } }
+  let(:partial_mockup) { mockup_locator.mockups.find {|m| m.slug =~ /^_/ } }
+  let(:admin_mockup) { mockup_locator.mockups.find {|m| m.slug =~ /admin/ } }
+
+  context "::mockups" do
+    it "returns all mockups in the pre-configured mockup directories" do
+      expect(mockup_locator.mockups.size).to eq(5)
+    end
+
+    it "returns mockups with Rails-friendly template names" do
+      expect(regular_mockup.template).to eq("mockups/processed")
+    end
+
+    it "returns mockups with the default layout if they have no discernible alternative" do
+      expect(regular_mockup.layout).to eq(GreatPretender.config.default_layout)
+    end
+
+    it "returns partials with no layout" do
+      expect(partial_mockup.layout).to be_nil
+    end
+
+    it "returns detected layouts for well-named mockups" do
+      expect(admin_mockup.layout).to eq("admin")
+    end
+  end
+
+  context "::find" do
+    it "returns mockups given a slug" do
+      expect(mockup_locator.find("processed")).to eq(regular_mockup)
+    end
+
+    it "returns nil given a bad mockup name" do
+      expect(mockup_locator.find("foobar")).to be_nil
+    end
+  end
+end

data/spec/lib/great_pretender/mockup_spec.rb

@@ -0,0 +1,26 @@
+require 'great_pretender/mockup'
+require_relative '../../support/mockup_helpers'
+
+describe GreatPretender::Mockup do
+
+  include MockupHelpers
+
+  let(:mockup) { mockup_locator.mockups.find {|m| m.slug =~ /admin/ } }
+
+  it "returns a human-readable name from its slug" do
+    expect(mockup.name).to eq("Admin > Index")
+  end
+
+  context ".to_param" do
+    it "returns the slug" do
+      expect(mockup.to_param).to eq(mockup.slug)
+    end
+  end
+
+  context ".updated_at" do
+    it "returns the template file's mtime for its slug" do
+      expect(mockup.updated_at).to eq(Time.at(1407427839))
+    end
+  end
+
+end

data/spec/support/mockup_helpers.rb

@@ -0,0 +1,26 @@
+module MockupHelpers
+  def self.included(base)
+    base.class_eval do
+
+      let(:paths) do
+        [
+          Pathname.new("spec/fixtures/view_path_a").expand_path,
+          Stub.new("spec/fixtures/view_path_b")
+        ]
+      end
+
+      let(:mockup_locator) { GreatPretender::MockupLocator.new(paths) }
+
+    end
+  end
+
+  class Stub
+    def initialize(path)
+      @path = path
+    end
+
+    def to_path
+      @path.to_s
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: great_pretender
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Flip Sasser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Use Great Pretender to easily add layout-specific mockups in a Rails
+  app without having to recreate the mockup wheel. Your design should be happening
+  in-browser; this will help you get there.
+email:
+- flip@inthebackforty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/great_pretender/mockups_controller.rb
+- app/helpers/great_pretender/mockups_helper.rb
+- app/views/great_pretender/index.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- great_pretender.gemspec
+- lib/great_pretender.rb
+- lib/great_pretender/config.rb
+- lib/great_pretender/controller.rb
+- lib/great_pretender/engine.rb
+- lib/great_pretender/mockup.rb
+- lib/great_pretender/mockup_locator.rb
+- lib/great_pretender/version.rb
+- spec/fixtures/view_path_a/.DS_Store
+- spec/fixtures/view_path_a/layouts/admin.html.slim
+- spec/fixtures/view_path_a/mockups/_partial.haml
+- spec/fixtures/view_path_a/mockups/no_processed.slim
+- spec/fixtures/view_path_a/mockups/processed.html.erb
+- spec/fixtures/view_path_b/mockups/_partial.html.haml
+- spec/fixtures/view_path_b/mockups/admin/index.html.erb
+- spec/lib/great_pretender/config_spec.rb
+- spec/lib/great_pretender/mockup_locator_spec.rb
+- spec/lib/great_pretender/mockup_spec.rb
+- spec/support/mockup_helpers.rb
+homepage: https://github.com/BackForty/great_pretender
+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.1
+signing_key: 
+specification_version: 4
+summary: Ridiculously easy-to-use Rails mockups for those enlightened individuals
+  who design in-browser
+test_files:
+- spec/fixtures/view_path_a/.DS_Store
+- spec/fixtures/view_path_a/layouts/admin.html.slim
+- spec/fixtures/view_path_a/mockups/_partial.haml
+- spec/fixtures/view_path_a/mockups/no_processed.slim
+- spec/fixtures/view_path_a/mockups/processed.html.erb
+- spec/fixtures/view_path_b/mockups/_partial.html.haml
+- spec/fixtures/view_path_b/mockups/admin/index.html.erb
+- spec/lib/great_pretender/config_spec.rb
+- spec/lib/great_pretender/mockup_locator_spec.rb
+- spec/lib/great_pretender/mockup_spec.rb
+- spec/support/mockup_helpers.rb