great_pretender 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d7bef2a3f4eedc66d221d827f8a6f747cb54b4c
-  data.tar.gz: 4e36bcc3085b77217e178240f1e6aa22098dfc52
+  metadata.gz: b0a84b26997b6eb8cf255e8f687a1b1b6238ce70
+  data.tar.gz: 5f7d90db4cf3dabd4c410d413237da15360d5e28
 SHA512:
-  metadata.gz: a2a4192ad7d8997fb34aad458289b6a189ca99b3d31b8f1f21bf8e6fd2fab7bf027b965192a275b335adf6faa179ded3016de479e53bd1447314e62332b88444
-  data.tar.gz: f9f15adcb02f5466ee6447267e2c00374bf2a839943a90726e6677ea4cfd17f8ffe2ab630e742f1a2bc2e9ae020c19071d234732981a6acbcf2374c7c8eb278d
+  metadata.gz: 2c6e1dcc3080c725c1e1405346aad7f1b130b6b9dbc2504804ade1c5a535545379d3e4876ad6fc4ee8f00967619ee7bcf3d724b66d1b40f3fbf61a62a9ef350e
+  data.tar.gz: 3071b731a1bca2a49b3d97d7544221cf56bd5cd6bfc2908c4144ad4a358aef585422e811af35855ed3055389b84e7b9d7421316b727c5a7d804c336320142599

data/README.md

@@ -1,31 +1,163 @@
-# GreatPretender
+# Great Pretender
 
-TODO: Write a gem description
+**Ridiculously easy-to-use Rails mockups for those enlightened individuals who design in-browser.**
 
-## Installation
+## Features
 
-Add this line to your application's Gemfile:
+**Great Pretender** was designed to be easy and awesome. Here are a few of its neat features:
+
+- Supports multiple layouts
+- Supports nested mockup directories (e.g. `app/views/mockups/users/sessions/whatever.html.slim`)
+- Supports partials
+- Installs in 2 minutes as a Rails engine
+- Can be mixed in to other controllers for access control or whatever else you want to add
+- Configurable mockups folder name and default layout
+- Dances with wolves
+
+## Install
+
+Just add it to your Gemfile and go!
+
+1. Add it to your `Gemfile`
+
+	```ruby
+	group :development do
+	  gem 'great_pretender'
+	end
+	```
+
+2. Bundle
+
+		bundle install
+
+## Configuration
+
+You can override two things in Great Pretender:
+
+1. The mockups folder name (default is `mockups`, as in `app/views/mockups`)
+2. The default layout to render mockups within (default is `application`, as in the one you normally use)
+
+You can add `config/initializers/great_pretender.rb` and configure it to your liking:
+
+```ruby
+if defined? GreatPretender
+  GreatPretender.config do |c|
+    c.default_layout = "public_facing"
+    c.view_path = "wireframes"
+  end
+end
+```
+
+## Getting Started
+
+### With the Rails engine
+
+If you're just using Great Pretender to pass mockups from designer to developer, you can get started really easily by adding it to  `config/routes.rb`:
 
 ```ruby
-gem 'great_pretender'
+Rails.application.routes.draw do
+  mount GreatPretender::Engine, at: 'mockups' if defined?(GreatPretender)
+end
 ```
 
-And then execute:
+Take care to load it only in the environments you want. Typically I've seen just the development environment, but I also know people who use mockups on staging to show remote clients.
+
+### With your own controller
+
+Some people want to have a little bit more control over their mockups (in order to, for example, require an admin account to view them on a staging server).
+
+If that's the case, you can create your own controller that uses Great Pretender:
+
+1. Create a controller that uses whatever inheritance you're interested in, and mix `GreatPretender::Controller` into it:
+
+	```ruby
+	class Admin::MockupsController < Admin::ApplicationController
+
+	  include GreatPretender::Controller
+
+	  before_action :require_admin_user! # or whatever
 
-    $ bundle
+	  layout 'admin' # or whatever
 
-Or install it yourself as:
+	end
+	```
 
-    $ gem install great_pretender
+2. Manually add routes to the Great Pretender actions (`index` and `show`). **Please note** that the `show` action requires a `*splat`-style id:
+
+	```ruby
+	Rails.application.routes.draw do
+	  namespace :admin do
+	    # ... your other stuff ...
+	    get 'mockups', to: 'mockups#index', as: :mockups
+	    get 'mockups/*id', to: 'mockups#show', as: :mockup
+	  end
+	end
+	```
+
+3. **(OPTIONAL)** Override the `great_pretender/index.html` template to render it in your custom interface.
+
+	Available helper methods are `mockups` (an array of `GreatPretender::Mockup` objects) and `mockup_root` (the path where you should add mockups).
+
+	Here's an example:
+
+	```
+	%ul
+	  - mockups.each do |mockup|
+	    %li= link_to mockup.name, admin_mockup_path(mockup)
+	```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Creating mockups
+
+Once you've got Great Pretender up and running, you should add some mockups. By default, you would put these in `app/views/mockups`, but if you overrode `view_path` in `GreatPretender.config.view_path`, you would use `app/views/whatever_you_overrode_it_to`.
+
+1. Add a mockup file
+
+	For example, in `app/views/mockups/users/show.html.slim`:
+
+	```
+	header= image_tag "logo.png"
+	p
+	  | I can use regular Rails helpers because this is just a template file!
+	  ' Hooray!
+	```
+
+2. Open your browser and navigate to whatever path you installed Great Pretender on (90% of cases I'm guessing will be in `http://localhost:3000/mockups`). Then click on your mockup.
+
+3. Profit
+
+### Creating partials
+
+You can add partials like you would anywhere else. Just prefix them with a skid (`_`) and go from there.
+
+By default, partials render **without a layout**, so you can request them using AJAX and receive the HTML free of all that layout cruft.
+
+If you *want* to receive a layout as part of it, use a custom layout (see next section) and just request that mockups' path.
+
+### Using alternative layouts
+
+If you're designing for a site with multiple layouts, you can simply nest mockup files in a folder with the name of a layout, and they'll be rendered with that layout. For example, with the following structure...
+
+```
+app/
+|- views/
+|--- layouts/
+|----- application.html.slim
+|----- admin.html.slim
+|--- mockups/
+|----- admin/
+|------- index.html.slim
+|------- users/
+|--------- index.html.slim
+```
+
+...all of the mockups in `app/views/mockups/admin` would render using the `admin` layout.
+
+Using this strategy, you can name your mockups clearly after their conceptual section in your app.
+
+## The end!
 
-## Contributing
+Thanks for using Great Pretender! I hope it helps you like it's helped us!
 
-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
+Copyright &copy; 2014 [Back Forty LLC](http://www.inthebackforty.com/)

data/lib/great_pretender/mockup_locator.rb

@@ -62,7 +62,6 @@ module GreatPretender
           @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

data/lib/great_pretender/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: great_pretender
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Flip Sasser