mountain_view 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d65e26c365858e61121a0b3bbb8f2f90907f0c84
-  data.tar.gz: 05fc336f347ca1d67e6b9eff203b66fc74f8012e
+  metadata.gz: 1e5372e43b1558e8d4bb5311670139d5e64314ae
+  data.tar.gz: 54e9f3117a3621881bb0cbabf9b4676a4857e2cc
 SHA512:
-  metadata.gz: 19e480f95a51f78bdcd169040700c865ca2dd26bd8172699c8e002a31f43956b4f64411db83a75d0aadbc64ecca3bf5cabf70dc591a1d804484875919b367dcd
-  data.tar.gz: c1c20a2fa1e7c54514679f8873372f64b9667c7582c39b6c1b7df89e3bedad70b716e5e74382eb6667901f213cf245c92d2eae21b67c34fe38774e283907597a
+  metadata.gz: 66ae520bd6291a77ea1092a3fb1b88122d16b6d73736be3229fb9e574c73000ea2b7f8419b4aff2b83d4a48c7430faac24f1b2c6a91ead371144ce7c52ae1285
+  data.tar.gz: 46f45ab23a85b023023f8d630a2bc5fffe17985eb0e7e6a7bd38d6743d90633e31fb75a277dc61bc6c2246b94ef8f8896045e2bf8838ebe3d91da8b622fe2592

data/README.md

@@ -19,8 +19,13 @@ Then execute:
 
 ## Usage
 
-### Directory Structure
-Create components following this directory structure:
+Use the built-in generator to create a new component:
+
+```
+rails generate mountain_view:component header
+```
+
+This will create the following directory structure:
 
 ```
 app/
@@ -32,12 +37,6 @@ app/
       header.yml
 ```
 
-You can use the built-in generator, to automate the behavior:
-
-```
-rails generate mountain_view:component header
-```
-
 Keep in mind that you can also use `scss`, `coffeescript`, `haml`, or any other
 preprocessors that your app is currently using.
 
@@ -103,8 +102,11 @@ E.g: `app/components/card/card.yml`
 3) Vist `http://localhost:3000/mountain_view/styleguide`
 
 #### Example Style Guide
-![mountain_view](https://cloud.githubusercontent.com/assets/623766/7099771/5b06d8da-dfd4-11e4-8558-1b7f026f28ad.gif)
 
+Visit the **[live demo!](https://mountain-view.herokuapp.com/mountain_view/styleguide)**
+([source repo](https://github.com/jgnatch/mountain_view_demo))
+
+![mountain_view](https://cloud.githubusercontent.com/assets/623766/7099771/5b06d8da-dfd4-11e4-8558-1b7f026f28ad.gif)
 
 ## Contributing
 

data/app/controllers/mountain_view/styleguide_controller.rb

@@ -3,7 +3,7 @@ module MountainView
     layout "mountain_view"
 
     def show
-      @component = params[:id]
+      @component = MountainView::Component.new(params[:id])
     end
   end
 end

data/app/helpers/mountain_view/styleguide_helper.rb

@@ -2,13 +2,8 @@ module MountainView
   module StyleguideHelper
     def mv_components
       Dir.glob(Rails.root.join("app", "components", "*")).map do |component_dir|
-        File.basename component_dir
+        MountainView::Component.new File.basename(component_dir)
       end
     end
-
-    def styleguide_stubs(component_name)
-      stubs_file = Rails.root.join("app/components/#{component_name}/#{component_name}.yml")
-      YAML.load_file stubs_file
-    end
   end
 end

data/app/views/layouts/mountain_view.html.erb

@@ -17,7 +17,7 @@
       <ul>
         <%- mv_components.each do |component| %>
           <li>
-            <%= link_to component.capitalize, styleguide_path(id: component) %>
+            <%= link_to component.title, styleguide_path(id: component.name) %>
           </li>
         <% end %>
       </ul>

data/app/views/mountain_view/styleguide/show.html.erb

@@ -1,16 +1,16 @@
 <div class="mv-main__header">
-  <h1><%= @component.capitalize %></h1>
+  <h1><%= @component.title %></h1>
 </div>
 
-<% styleguide_stubs(@component).each_with_index do |component_properties, index| %>
+<% @component.styleguide_stubs.each_with_index do |component_properties, index| %>
   <div class="mv-component">
     <div class="mv-component__item">
-      <%= render_component @component, component_properties %>
+      <%= render_component @component.name, component_properties %>
     </div>
     <div class="mv-component__description">
-      <h2><%= @component.capitalize %> <%= index + 1 %></h2>
+      <h2><%= @component.title %> <%= index + 1 %></h2>
       <div class="mv-component__description__definition">
-        <code class="language-ruby">&lt;%= render_component("<%= @component %>", {properties as below}) %&gt;</code>
+        <code class="language-ruby">&lt;%= render_component("<%= @component.name %>", {properties as below}) %&gt;</code>
       </div>
       <%- formatted = JSON.pretty_generate component_properties %>
       <div class="mv-component__description__properties">

data/lib/mountain_view/component.rb

@@ -0,0 +1,23 @@
+module MountainView
+  class Component
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def title
+      @name.humanize
+    end
+
+    def styleguide_stubs
+      YAML.load_file stubs_file
+    end
+
+    private
+
+    def stubs_file
+      Rails.root.join("app/components/#{name}/#{name}.yml")
+    end
+  end
+end

data/lib/mountain_view/engine.rb

@@ -1,5 +1,6 @@
-require 'mountain_view'
-require 'rails'
+require "rails"
+require "mountain_view"
+require "mountain_view/component"
 
 module MountainView
   class Engine < ::Rails::Engine

data/lib/mountain_view/version.rb

@@ -1,3 +1,3 @@
 module MountainView
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/test/dummy/log/test.log

@@ -2532,3 +2532,298 @@ Processing by MountainView::StyleguideController#show as HTML
   Rendered app/components/header/_header.html.erb (0.0ms)
   Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (2.7ms)
 Completed 200 OK in 5ms (Views: 4.9ms)
+------------------------------------------------------------------
+ComponentGeneratorTest: test_Assert_all_files_are_properly_created
+------------------------------------------------------------------
+--------------------------------------------------------
+ComponentGeneratorTest: test_Generates_different_engines
+--------------------------------------------------------
+--------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_the_proper_component
+--------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (2.3ms)
+---------------------------------------
+MountainViewTest: test_engine_is_loaded
+---------------------------------------
+---------------------------------------
+MountainViewTest: test_shows_styleguide
+---------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2015-04-23 11:21:19 -0400
+Processing by MountainView::StyleguideController#index as HTML
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/index.html.erb within layouts/mountain_view (0.4ms)
+Completed 200 OK in 202ms (Views: 201.8ms)
+-----------------------------------------------
+MountainViewTest: test_shows_specific_component
+-----------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2015-04-23 11:21:19 -0400
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"header"}
+  Rendered app/components/header/_header.html.erb (0.4ms)
+  Rendered app/components/header/_header.html.erb (0.0ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (3.1ms)
+Completed 200 OK in 6ms (Views: 6.2ms)
+------------------------------------------------------
+MountainViewTest: test_stylesheets_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2015-04-23 11:21:19 -0400
+------------------------------------------------------
+MountainViewTest: test_javascripts_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2015-04-23 11:21:19 -0400
+--------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_the_proper_component
+--------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (1.1ms)
+------------------------------------------------------------------
+ComponentGeneratorTest: test_Assert_all_files_are_properly_created
+------------------------------------------------------------------
+--------------------------------------------------------
+ComponentGeneratorTest: test_Generates_different_engines
+--------------------------------------------------------
+-----------------------------------------------
+MountainViewTest: test_shows_specific_component
+-----------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2015-04-23 11:21:35 -0400
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"header"}
+  Rendered app/components/header/_header.html.erb (0.5ms)
+  Rendered app/components/header/_header.html.erb (0.1ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (2.9ms)
+Completed 200 OK in 208ms (Views: 207.8ms)
+------------------------------------------------------
+MountainViewTest: test_javascripts_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2015-04-23 11:21:35 -0400
+---------------------------------------
+MountainViewTest: test_shows_styleguide
+---------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2015-04-23 11:21:35 -0400
+Processing by MountainView::StyleguideController#index as HTML
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/index.html.erb within layouts/mountain_view (0.3ms)
+Completed 200 OK in 2ms (Views: 2.4ms)
+---------------------------------------
+MountainViewTest: test_engine_is_loaded
+---------------------------------------
+------------------------------------------------------
+MountainViewTest: test_stylesheets_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2015-04-23 11:21:35 -0400
+------------------------------------------------------
+MountainViewTest: test_stylesheets_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2015-04-23 11:27:33 -0400
+---------------------------------------
+MountainViewTest: test_shows_styleguide
+---------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2015-04-23 11:27:33 -0400
+Processing by MountainView::StyleguideController#index as HTML
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/index.html.erb within layouts/mountain_view (1.5ms)
+Completed 200 OK in 55ms (Views: 54.6ms)
+-----------------------------------------------
+MountainViewTest: test_shows_specific_component
+-----------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2015-04-23 11:27:34 -0400
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"header"}
+  Rendered app/components/header/_header.html.erb (0.5ms)
+  Rendered app/components/header/_header.html.erb (0.0ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (5.9ms)
+Completed 200 OK in 9ms (Views: 8.6ms)
+---------------------------------------
+MountainViewTest: test_engine_is_loaded
+---------------------------------------
+------------------------------------------------------
+MountainViewTest: test_javascripts_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2015-04-23 11:27:34 -0400
+------------------------------------------------------------------
+ComponentGeneratorTest: test_Assert_all_files_are_properly_created
+------------------------------------------------------------------
+--------------------------------------------------------
+ComponentGeneratorTest: test_Generates_different_engines
+--------------------------------------------------------
+--------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_the_proper_component
+--------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (14.4ms)
+---------------------------------------
+MountainViewTest: test_engine_is_loaded
+---------------------------------------
+---------------------------------------
+MountainViewTest: test_shows_styleguide
+---------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2015-04-23 11:28:01 -0400
+Processing by MountainView::StyleguideController#index as HTML
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/index.html.erb within layouts/mountain_view (0.9ms)
+Completed 200 OK in 202ms (Views: 202.3ms)
+-----------------------------------------------
+MountainViewTest: test_shows_specific_component
+-----------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2015-04-23 11:28:01 -0400
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"header"}
+  Rendered app/components/header/_header.html.erb (0.5ms)
+  Rendered app/components/header/_header.html.erb (0.1ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (6.4ms)
+Completed 200 OK in 9ms (Views: 9.3ms)
+------------------------------------------------------
+MountainViewTest: test_javascripts_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2015-04-23 11:28:01 -0400
+------------------------------------------------------
+MountainViewTest: test_stylesheets_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2015-04-23 11:28:01 -0400
+--------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_the_proper_component
+--------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (0.6ms)
+------------------------------------------------------------------
+ComponentGeneratorTest: test_Assert_all_files_are_properly_created
+------------------------------------------------------------------
+--------------------------------------------------------
+ComponentGeneratorTest: test_Generates_different_engines
+--------------------------------------------------------
+------------------------------------------------------
+MountainViewTest: test_javascripts_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2015-04-23 11:37:20 -0400
+---------------------------------------
+MountainViewTest: test_engine_is_loaded
+---------------------------------------
+---------------------------------------
+MountainViewTest: test_shows_styleguide
+---------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2015-04-23 11:37:20 -0400
+Processing by MountainView::StyleguideController#index as HTML
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/index.html.erb within layouts/mountain_view (1.4ms)
+Completed 200 OK in 59ms (Views: 58.6ms)
+-----------------------------------------------
+MountainViewTest: test_shows_specific_component
+-----------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2015-04-23 11:37:21 -0400
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"header"}
+  Rendered app/components/header/_header.html.erb (0.7ms)
+  Rendered app/components/header/_header.html.erb (0.0ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (5.5ms)
+Completed 200 OK in 9ms (Views: 8.7ms)
+------------------------------------------------------
+MountainViewTest: test_stylesheets_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2015-04-23 11:37:21 -0400
+--------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_the_proper_component
+--------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (0.4ms)
+------------------------------------------------------------------
+ComponentGeneratorTest: test_Assert_all_files_are_properly_created
+------------------------------------------------------------------
+--------------------------------------------------------
+ComponentGeneratorTest: test_Generates_different_engines
+--------------------------------------------------------
+------------------------------------------------------------------
+ComponentGeneratorTest: test_Assert_all_files_are_properly_created
+------------------------------------------------------------------
+--------------------------------------------------------
+ComponentGeneratorTest: test_Generates_different_engines
+--------------------------------------------------------
+-----------------------------------------------
+MountainViewTest: test_shows_specific_component
+-----------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2015-04-23 11:54:07 -0400
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"header"}
+  Rendered app/components/header/_header.html.erb (0.5ms)
+  Rendered app/components/header/_header.html.erb (0.1ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (6.5ms)
+Completed 200 OK in 273ms (Views: 272.4ms)
+------------------------------------------------------
+MountainViewTest: test_javascripts_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2015-04-23 11:54:07 -0400
+---------------------------------------
+MountainViewTest: test_engine_is_loaded
+---------------------------------------
+---------------------------------------
+MountainViewTest: test_shows_styleguide
+---------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2015-04-23 11:54:07 -0400
+Processing by MountainView::StyleguideController#index as HTML
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/index.html.erb within layouts/mountain_view (0.5ms)
+Completed 200 OK in 6ms (Views: 5.6ms)
+------------------------------------------------------
+MountainViewTest: test_stylesheets_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2015-04-23 11:54:07 -0400
+--------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_the_proper_component
+--------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (0.7ms)
+--------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_the_proper_component
+--------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (1.8ms)
+-----------------------------------------------
+MountainViewTest: test_shows_specific_component
+-----------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2015-04-23 12:01:41 -0400
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"header"}
+  Rendered app/components/header/_header.html.erb (0.5ms)
+  Rendered app/components/header/_header.html.erb (0.0ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (3.6ms)
+Completed 200 OK in 231ms (Views: 230.3ms)
+---------------------------------------
+MountainViewTest: test_shows_styleguide
+---------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2015-04-23 12:01:41 -0400
+Processing by MountainView::StyleguideController#index as HTML
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/index.html.erb within layouts/mountain_view (0.4ms)
+Completed 200 OK in 3ms (Views: 3.1ms)
+------------------------------------------------------
+MountainViewTest: test_stylesheets_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2015-04-23 12:01:41 -0400
+---------------------------------------
+MountainViewTest: test_engine_is_loaded
+---------------------------------------
+------------------------------------------------------
+MountainViewTest: test_javascripts_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2015-04-23 12:01:41 -0400
+------------------------------------------------------------------
+ComponentGeneratorTest: test_Assert_all_files_are_properly_created
+------------------------------------------------------------------
+--------------------------------------------------------
+ComponentGeneratorTest: test_Generates_different_engines
+--------------------------------------------------------
+------------------------------------------------
+MountainViewComponentTest: test_styleguide_stubs
+------------------------------------------------
+------------------------------------
+MountainViewComponentTest: test_name
+------------------------------------
+-----------------------------------------------
+MountainViewComponentTest: test_humanized_title
+-----------------------------------------------
+  Rendered app/components/header/_header.html.erb (2.3ms)
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2015-04-23 12:01:57 -0400
+Compiled card/card.js  (0ms)  (pid 24975)
+Compiled header/header.js  (0ms)  (pid 24975)
+Compiled mountain_view.js  (8ms)  (pid 24975)
+Served asset /mountain_view.js - 200 OK (15ms)
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2015-04-23 12:01:57 -0400
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"header"}
+  Rendered app/components/header/_header.html.erb (0.3ms)
+  Rendered app/components/header/_header.html.erb (0.0ms)
+Completed 200 OK in 7.0ms (Views: 6.7ms)
+Started GET "/mountain_view" for 127.0.0.1 at 2015-04-23 12:01:57 -0400
+Processing by MountainView::StyleguideController#index as HTML
+Completed 200 OK in 2.2ms (Views: 2.0ms)
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2015-04-23 12:01:57 -0400
+Compiled card/card.css  (0ms)  (pid 24975)
+Compiled header/header.css  (0ms)  (pid 24975)
+Compiled mountain_view.css  (7ms)  (pid 24975)
+Served asset /mountain_view.css - 200 OK (12ms)

data/test/mountain_view/component_test.rb

@@ -0,0 +1,27 @@
+require "test_helper"
+
+class MountainViewComponentTest < ActiveSupport::TestCase
+  def test_name
+    component = MountainView::Component.new("header")
+
+    assert_equal "header", component.name
+  end
+
+  def test_humanized_title
+    component = MountainView::Component.new("social_media_icons")
+
+    assert_equal "Social media icons", component.title
+  end
+
+  def test_styleguide_stubs
+    component = MountainView::Component.new("header")
+
+    expected_stub = {
+      title: "20 Mountains you didn't know they even existed",
+      subtitle: "Buzzfeed title"
+    }
+
+    assert_instance_of Array, component.styleguide_stubs
+    assert_equal expected_stub, component.styleguide_stubs.first
+  end
+end