great_pretender 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0a84b26997b6eb8cf255e8f687a1b1b6238ce70
-  data.tar.gz: 5f7d90db4cf3dabd4c410d413237da15360d5e28
+  metadata.gz: 83426688dbe661c6888971ba60756bd22a22d8e9
+  data.tar.gz: 609888f148e55a50216994b642adb78527f8f56f
 SHA512:
-  metadata.gz: 2c6e1dcc3080c725c1e1405346aad7f1b130b6b9dbc2504804ade1c5a535545379d3e4876ad6fc4ee8f00967619ee7bcf3d724b66d1b40f3fbf61a62a9ef350e
-  data.tar.gz: 3071b731a1bca2a49b3d97d7544221cf56bd5cd6bfc2908c4144ad4a358aef585422e811af35855ed3055389b84e7b9d7421316b727c5a7d804c336320142599
+  metadata.gz: 3a87473df668fc6b002039e804e07aa0dfd3d93ed8e60aa671ca4077439e13795c0baa92409de6dec5d7b8c8dd3fa29dbc0a6c24e8afe058b44d88e203a18dc5
+  data.tar.gz: 416e2559c885fe04eb3a55a109e57b38a93944886dac8a1f8c8a734912b38654c263d6be76b03ada883f15d9d475f50f9c12d393c96f31449603674cbcd0c87c

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in great_pretender.gemspec
 gemspec
+gem "rspec-rails"

data/README.md

@@ -6,6 +6,7 @@
 
 **Great Pretender** was designed to be easy and awesome. Here are a few of its neat features:
 
+- Allows for easy stubbing with test data
 - Supports multiple layouts
 - Supports nested mockup directories (e.g. `app/views/mockups/users/sessions/whatever.html.slim`)
 - Supports partials
@@ -100,15 +101,13 @@ If that's the case, you can create your own controller that uses Great Pretender
 
 	Here's an example:
 
-	```
+	```haml
 	%ul
 	  - mockups.each do |mockup|
 	    %li= link_to mockup.name, admin_mockup_path(mockup)
 	```
 
-## Usage
-
-### Creating mockups
+## 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`.
 
@@ -116,18 +115,18 @@ Once you've got Great Pretender up and running, you should add some mockups. By
 
 	For example, in `app/views/mockups/users/show.html.slim`:
 
-	```
+	```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.
+2. Open your browser and navigate to whatever path you installed Great Pretender on (90% of cases I'm guessing will be at [http://localhost:3000/mockups](http://localhost:3000/mockups)). Then click on your mockup.
 
 3. Profit
 
-### Creating partials
+### Partials
 
 You can add partials like you would anywhere else. Just prefix them with a skid (`_`) and go from there.
 
@@ -135,7 +134,7 @@ By default, partials render **without a layout**, so you can request them using
 
 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
+### Multiple layout support
 
 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...
 
@@ -156,6 +155,54 @@ app/
 
 Using this strategy, you can name your mockups clearly after their conceptual section in your app.
 
+## Rendering With Test Data (Pretender Objects)
+
+A lot of the time you'll want to emulate real data in your views. In those cases, Great Pretender supports the use of "Pretender" objects in `app/pretenders`.
+
+Pretender objects can be any class. They can accept a single argument in `initialize`, which will be the the mockup being rendered, **or** they can skip it entirely.
+
+Any public method you add to a pretender object will be available to the view, just like helper methods.
+
+### Load order
+
+Pretenders, like layouts, are loaded based on the name of your mockup file. For example, a mockup named "users/login" would look for `app/pretenders/user(s)_pretender.rb` and `app/pretenders/login_pretender.rb`. **Please note** that plurally named templates will support a singular pretender, but singularly named templates will only load singular pretenders.
+
+Pretenders are delegated to in order of most specific (`LoginPretender`) to least specific (`UserPretender`). So if `LoginPretender` and `UserPretender` both define method `name`, the `LoginPretender`'s implementation will be used.
+
+### Example
+
+Here's an example using the excellent [Faker gem](https://github.com/stympy/faker) (I leave it to you to figure out how you want to generate test data, but Faker is pretty awesome).
+
+#### `app/pretenders/user_pretender.rb`
+
+```ruby
+require "faker"
+
+class UserPretender
+
+  def login
+    Faker::Internet.user_name
+  end
+
+  def email
+    Faker::Internet.email
+  end
+
+end
+```
+
+#### `app/views/mockups/users/login.html.slim`
+
+
+```slim
+header
+  | Welome back, #{login}!
+  | Your email is set to #{email}
+
+  / The remainder of your login form mockup...
+```
+
+
 ## The end!
 
 Thanks for using Great Pretender! I hope it helps you like it's helped us!

data/lib/great_pretender/controller.rb

@@ -1,4 +1,5 @@
 require "great_pretender/mockup_locator"
+require "great_pretender/pretender"
 
 module GreatPretender
   module Controller
@@ -41,5 +42,15 @@ module GreatPretender
       @great_pretender_mockup_root ||= mockup_locator.view_paths.first.join(GreatPretender.config.view_path)
     end
 
+    def pretender
+      @great_pretender_pretender ||= Pretender.new(mockup)
+    end
+
+    def view_context
+      super.tap do |view_context|
+        view_context.extend pretender.to_module if mockup
+      end
+    end
+
   end
 end

data/lib/great_pretender/engine.rb

@@ -1,4 +1,9 @@
 module GreatPretender
   class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.autoload_paths.push(Pathname.new('').join('app', 'pretenders').expand_path.to_s)
   end
 end

data/lib/great_pretender/pretender.rb

@@ -0,0 +1,62 @@
+require "active_support/core_ext/string/inflections"
+
+module GreatPretender
+  class Pretender
+
+    def initialize(mockup)
+      @mockup = mockup
+    end
+
+    def to_module
+      pretenders = load_pretenders
+
+      Module.new do
+        define_method(:method_missing) do |method_name, *args, &block|
+          pretender = pretenders.find { |p| p.respond_to?(method_name) }
+
+          if pretender
+            pretender.send(method_name, *args, &block)
+          else
+            super(method_name, *args, &block)
+          end
+        end
+      end
+    end
+
+    private
+
+    def load_pretender(class_name)
+      class_name = class_name + 'Pretender'
+      begin
+        klass = class_name.constantize
+      rescue NameError
+        return nil
+      end
+
+      initialize = klass.instance_method(:initialize)
+
+      if initialize.arity == 1
+        klass.new(@mockup)
+      else
+        klass.new
+      end
+    end
+
+    def load_pretenders
+      pretenders = []
+      @mockup.slug.split("/").each do |pretender_name|
+        # Given a mockup named something like 'social_contents',
+        # support pretenders named 'SocialContentsPretender' AND 'SocialContentPretender'
+        first_class = pretender_name.classify
+        second_class = pretender_name.split("_").map(&:titleize).join
+        [first_class, second_class].uniq.each do |class_name|
+          if instance = load_pretender(class_name)
+            pretenders.push(instance)
+          end
+        end
+      end
+      pretenders.reverse
+    end
+
+  end
+end

data/lib/great_pretender/version.rb

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

data/spec/lib/great_pretender/pretender_spec.rb

@@ -0,0 +1,33 @@
+require 'great_pretender/pretender'
+require 'ostruct'
+
+class PrefixSlugPretender
+  def say_hello
+    "Hello, guest!"
+  end
+end
+
+class TestSlugPretender
+  def ohai
+    "ohai"
+  end
+end
+
+describe GreatPretender::Pretender do
+
+  let(:mockup) { OpenStruct.new(slug: "prefix_slug/test_slug") }
+  let(:pretender) { GreatPretender::Pretender.new(mockup) }
+  let(:recipient) do
+    mod = pretender.to_module
+    Class.new { include mod }.new
+  end
+
+  it "delegates methods to pretenders named after mockups" do
+    expect(recipient.ohai).to eq("ohai")
+  end
+
+  it "delegates methods to pretenders in the slug chain" do
+    expect(recipient.say_hello).to eq("Hello, guest!")
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: great_pretender
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - Flip Sasser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-07 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ files:
 - lib/great_pretender/engine.rb
 - lib/great_pretender/mockup.rb
 - lib/great_pretender/mockup_locator.rb
+- lib/great_pretender/pretender.rb
 - lib/great_pretender/version.rb
 - spec/fixtures/view_path_a/.DS_Store
 - spec/fixtures/view_path_a/layouts/admin.html.slim
@@ -76,6 +77,7 @@ files:
 - spec/lib/great_pretender/config_spec.rb
 - spec/lib/great_pretender/mockup_locator_spec.rb
 - spec/lib/great_pretender/mockup_spec.rb
+- spec/lib/great_pretender/pretender_spec.rb
 - spec/support/mockup_helpers.rb
 homepage: https://github.com/BackForty/great_pretender
 licenses:
@@ -113,4 +115,5 @@ test_files:
 - spec/lib/great_pretender/config_spec.rb
 - spec/lib/great_pretender/mockup_locator_spec.rb
 - spec/lib/great_pretender/mockup_spec.rb
+- spec/lib/great_pretender/pretender_spec.rb
 - spec/support/mockup_helpers.rb