mountain_view 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1492e39aab18154eb640fe41234f348137c41523
-  data.tar.gz: b02850181a73d4770cdc21b06d2d316acc185792
+  metadata.gz: 15f33c63263b41389c39e9084c63007a8312307b
+  data.tar.gz: 16f99753bd173370de472a63f771e56a3cabaed4
 SHA512:
-  metadata.gz: e9c2bb5124b7e27314d536d6bed2ee02fb4658928600aa9fe365157594cca662dd7bfb30dbed34c16710e1f19cb45c098acfe8117dbce8e23636bad8f34fdbb1
-  data.tar.gz: e91297418a2bef52a765f2ce598e837af274a1856c260202d57d68f98bd9a81395f821ecd0b9ad7ece1b47874810f86c818b892d0ce53dade5cb8cf9ab39f1c1
+  metadata.gz: b1215573a1bb3e96345b7267067a074992078bf2aab0d11fbc098b56bfa8abc55d6c88f7b80a18e861902e4d5d0ed02eba8b85b8cf218e03ab0d96d84c958ec1
+  data.tar.gz: 67b571c9369e9bd9d01e5ff87b05746e070c3f193843e5c62650d6d7842e31cbd4eb973a193f4c6d988a5ac63832eaf1b856ef8677ae644d246b763ecec2d3f0

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://travis-ci.org/devnacho/mountain_view.svg?branch=master)](https://travis-ci.org/devnacho/mountain_view)
 [![Code Climate](https://codeclimate.com/github/devnacho/mountain_view/badges/gpa.svg)](https://codeclimate.com/github/devnacho/mountain_view)
 
-With Mountain View you create reusable components for your Rails frontend, while generating a living style guide. 
+With Mountain View you create reusable components for your Rails frontend, while generating a living style guide.
 
 **FAQ**
 
@@ -95,8 +95,8 @@ end
 
 Including a component class is optional, but it helps avoid polluting your
 views and helpers with presenter logic. Public methods in your component class
-will be made available to the view, along with any properties you define. 
-You can also access all properties using the `properties` method in your 
+will be made available to the view, along with any properties you define.
+You can also access all properties using the `properties` method in your
 component class and views. You can even define property defaults.
 
 ### Using components on your views
@@ -160,6 +160,25 @@ For SASS mixins, variables, functions, etc (anything that doesn't generate
 code), you'd need to explicitly do and `@import` in each component stylesheet.
 As that doesn't generate extra CSS this won't cause any issues with the
 generated CSS, you're only giving that stylesheet access to those definitions.
+=======
+
+
+### Adding extra pages to the styleguide
+In case you want to add additional pages to the styleguide (e.g grid, code_style) to your living style guide, you can do it by generating them in an initializer
+
+```ruby
+MountainView.configure do |config|
+  config.extra_pages = [:grid, :code_style]
+end
+```
+
+This will generate the routes and conventional links to the style guide.
+
+To add the views to handle the request.
+
+```
+rails generate mountain_view:extra_pages
+```
 
 ## Automatically generated Style Guide
 A style guide will be automatically generated. This style guide never falls behind and it reflects your components in their latest version.

data/app/controllers/mountain_view/extra_pages_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MountainView
+  class ExtraPagesController < ::ApplicationController
+    layout "mountain_view"
+
+    def show
+      render template: "mountain_view/extra_pages/#{params[:page]}"
+    end
+  end
+end

data/app/helpers/mountain_view/application_helper.rb

@@ -23,5 +23,9 @@ module MountainView
         super
       end
     end
+
+    def extra_pages
+      MountainView.configuration.extra_pages
+    end
   end
 end

data/app/helpers/mountain_view/styleguide_helper.rb

@@ -1,5 +1,9 @@
 module MountainView
   module StyleguideHelper
+    def prettify_word(word)
+      word.to_s.split("_").map(&:capitalize).join(" ")
+    end
+
     def mv_components
       component_dirs = MountainView.configuration.components_path.join("*")
       Dir.glob(component_dirs).map do |component_dir|

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

@@ -13,6 +13,16 @@
   </div>
   <div class="mv-flex-wrapper">
     <div class="mv-sidebar">
+      <% if extra_pages.any? %>
+        <h3>EXTRA PAGES</h3>
+        <ul>
+          <%- extra_pages.each do |extra_page| %>
+            <li>
+              <%= link_to prettify_word(extra_page), extra_pages_path(extra_page) %>
+            </li>
+          <% end %>
+        </ul>
+      <% end %>
       <h3>COMPONENTS</h3>
       <ul>
         <%- mv_components.each do |component| %>

data/config/routes.rb

@@ -1,5 +1,12 @@
 MountainView::Engine.routes.draw do
   root to: "styleguide#index"
 
+  def extra_routes
+    get "extra_pages/:page",
+        to: "extra_pages#show",
+        as: "extra_pages"
+  end
+
   resources :styleguide, only: [:index, :show], path: MountainView.configuration.styleguide_path
+  extra_routes if MountainView.configuration.extra_pages.any?
 end

data/lib/generators/mountain_view/component_generator.rb

@@ -1,8 +1,10 @@
-require "rails/generators/base"
+# frozen_string_literal: true
+
+require_relative "./mountain_view_generator_base"
 
 module MountainView
   module Generators
-    class ComponentGenerator < Rails::Generators::Base
+    class ComponentGenerator < MountainViewGeneratorBase
       desc "Generates all files needed for a component"
 
       argument :component, required: true,
@@ -23,24 +25,6 @@ module MountainView
       def create_stubs_file
         create_file "app/components/#{component}/#{component}.yml"
       end
-
-      private
-
-      def template_engine
-        app_generators[:template_engine] || "erb"
-      end
-
-      def stylesheet_engine
-        app_generators[:stylesheet_engine] || "css"
-      end
-
-      def javascript_engine
-        app_generators[:javascript_engine] || "js"
-      end
-
-      def app_generators
-        Rails.application.config.generators.rails
-      end
     end
   end
 end

data/lib/generators/mountain_view/extra_pages_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "./mountain_view_generator_base"
+
+module MountainView
+  module Generators
+    class ExtraPagesGenerator < MountainViewGeneratorBase
+      desc "Generates extra pages and routes"
+
+      def create_extra_pages_views
+        views_folder = "app/views/mountain_view/extra_pages"
+        extra_pages.each do |page|
+          file_name = "#{views_folder}/#{page}.html.#{template_engine}"
+          next if File.exist?(file_name)
+          create_file file_name
+        end
+      end
+    end
+  end
+end

data/lib/generators/mountain_view/mountain_view_generator_base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module MountainView
+  module Generators
+    class MountainViewGeneratorBase < Rails::Generators::Base
+      private
+
+      def template_engine
+        app_generators[:template_engine] || "erb"
+      end
+
+      def stylesheet_engine
+        app_generators[:stylesheet_engine] || "css"
+      end
+
+      def javascript_engine
+        app_generators[:javascript_engine] || "js"
+      end
+
+      def app_generators
+        Rails.application.config.generators.rails
+      end
+
+      def extra_pages
+        MountainView.configuration.extra_pages
+      end
+    end
+  end
+end

data/lib/mountain_view/configuration.rb

@@ -2,10 +2,12 @@ module MountainView
   class Configuration
     attr_accessor :included_stylesheets
     attr_accessor :styleguide_path
+    attr_accessor :extra_pages
     attr_reader :components_path
 
     def initialize
       @included_stylesheets = []
+      @extra_pages = []
     end
 
     def components_path=(path)

data/lib/mountain_view/version.rb

@@ -1,3 +1,3 @@
 module MountainView
-  VERSION = "0.11.0".freeze
+  VERSION = "0.12.0".freeze
 end

data/test/dummy/app/views/layouts/application.html.erb

@@ -7,8 +7,6 @@
   <%= csrf_meta_tags %>
 </head>
 <body>
-<h1>HEADER</h1>
 <%= yield %>
-
 </body>
 </html>

data/test/dummy/app/views/mountain_view/extra_pages/grid.html.erb

@@ -0,0 +1 @@
+<h1>Hello</h1>

data/test/dummy/config/initializers/mountain_view.rb

@@ -1,3 +1,4 @@
 MountainView.configure do |config|
   config.included_stylesheets = ["global"]
+  config.extra_pages = %I(grid code_style)
 end

data/test/dummy/log/test.log

@@ -148,3 +148,170 @@ MountainView::PresenterTest: test_inherited_presenter_responds_to_#data
 ------------------------------------------------------------------
 MountainView::PresenterTest: test_returns_the_correct_partial_path
 ------------------------------------------------------------------
+------------------------------------------------------------------
+ComponentGeneratorTest: test_Assert_all_files_are_properly_created
+------------------------------------------------------------------
+--------------------------------------------------------
+ComponentGeneratorTest: test_Generates_different_engines
+--------------------------------------------------------
+-------------------------------------------------
+MountainViewComponentTest: test_stubs_extra_info?
+-------------------------------------------------
+-----------------------------------------------------
+MountainViewComponentTest: test_stubs_correct_format?
+-----------------------------------------------------
+------------------------------------------------
+MountainViewComponentTest: test_stubs_extra_info
+------------------------------------------------
+------------------------------------------------
+MountainViewComponentTest: test_component_stubs?
+------------------------------------------------
+------------------------------------------
+MountainViewComponentTest: test_stubs_file
+------------------------------------------
+-----------------------------------------------
+MountainViewComponentTest: test_component_stubs
+-----------------------------------------------
+------------------------------------
+MountainViewComponentTest: test_name
+------------------------------------
+--------------------------------------
+MountainViewComponentTest: test_stubs?
+--------------------------------------
+------------------------------------------------
+MountainViewComponentTest: test_styleguide_stubs
+------------------------------------------------
+-----------------------------------------------
+MountainViewComponentTest: test_humanized_title
+-----------------------------------------------
+-------------------------------------------------------------------
+MountainViewConfigurationTest: test_set_custom_included_stylesheets
+-------------------------------------------------------------------
+--------------------------------------------------------------------------------------------
+MountainViewConfigurationTest: test_default_value_for_included_stylesheets_is_an_empty_array
+--------------------------------------------------------------------------------------------
+----------------------------------------------------------------------------
+MountainViewConfigurationTest: test_default_value_for_styleguide_path_is_nil
+----------------------------------------------------------------------------
+--------------------------------------------------------------
+MountainViewConfigurationTest: test_set_custom_styleguide_path
+--------------------------------------------------------------
+---------------------------------------
+MountainViewTest: test_engine_is_loaded
+---------------------------------------
+-------------------------------------------------------------
+MountainViewTest: test_global_stylesheets_are_properly_served
+-------------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+MountainView: stylesheet not found for component 'paragraph'
+-----------------------------------------------------------------------------------
+MountainViewTest: test_shows_a_hint_message_if_the_component_stub_file_is_not_found
+-----------------------------------------------------------------------------------
+Started GET "/mountain_view/styleguide/something" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"something"}
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/_example.html.erb (0.5ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (9.6ms)
+MountainView: javascript not found for component 'paragraph'
+Completed 200 OK in 92ms (Views: 91.2ms)
+-----------------------------------------------------------------------------
+MountainViewTest: test_shows_specific_component_that_uses_a_main_app_url_okay
+-----------------------------------------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"header"}
+  Rendered app/components/header/_header.html.erb (2.2ms)
+  Rendered app/components/header/_header.html.erb (0.2ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (14.4ms)
+Completed 200 OK in 18ms (Views: 17.7ms)
+---------------------------------------
+MountainViewTest: test_shows_styleguide
+---------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+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.6ms)
+Completed 200 OK in 5ms (Views: 4.4ms)
+------------------------------------------------------
+MountainViewTest: test_stylesheets_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+------------------------------------------------------
+MountainViewTest: test_javascripts_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+-----------------------------------------------
+MountainViewTest: test_shows_specific_component
+-----------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+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.2ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (9.0ms)
+Completed 200 OK in 11ms (Views: 11.2ms)
+-------------------------------------------------------------------------------
+MountainViewTest: test_shows_a_hint_message_if_the_component_stub_file_is_empty
+-------------------------------------------------------------------------------
+Started GET "/mountain_view/styleguide/breadcrumbs" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+Processing by MountainView::StyleguideController#show as HTML
+  Parameters: {"id"=>"breadcrumbs"}
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/_example.html.erb (0.1ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (0.7ms)
+Completed 200 OK in 3ms (Views: 2.9ms)
+-------------------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_a_component_within_a_compontent
+-------------------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (1.9ms)
+  Rendered app/components/yielder/_yielder.html.erb (0.5ms)
+------------------------------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_Does_not_override_passed_yield_property_with_block
+------------------------------------------------------------------------------------------
+  Rendered app/components/yielder/_yielder.html.erb (0.1ms)
+--------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_the_proper_component
+--------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (0.2ms)
+-------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_when_passed_a_block
+-------------------------------------------------------------------
+  Rendered app/components/yielder/_yielder.html.erb (0.1ms)
+-------------------------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_when_has_a_yield,_but_no_block_passed
+-------------------------------------------------------------------------------------
+  Rendered app/components/yielder/_yielder.html.erb (0.1ms)
+-------------------------------------------------------------------------------
+MountainView::PresenterTest: test_inherited_presenter_returns_the_correct_title
+-------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------
+MountainView::PresenterTest: test_inherited_presenter_returns_the_default_value_for_#data
+-----------------------------------------------------------------------------------------
+-----------------------------------------------------------------------
+MountainView::PresenterTest: test_inherited_presenter_responds_to_#data
+-----------------------------------------------------------------------
+------------------------------------------------------------------
+MountainView::PresenterTest: test_returns_the_correct_partial_path
+------------------------------------------------------------------
+----------------------------------------------------------------
+MountainView::PresenterTest: test_exposes_properties_as_provided
+----------------------------------------------------------------
+-------------------------------------------------------------------------
+MountedEngineTest: test_Custom_path_can_be_applied_to_styleguide_resource
+-------------------------------------------------------------------------
+Started GET "/mountain_view/style-guide" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+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.3ms)
+-----------------------------------------------------
+MountedEngineTest: test_Has_been_mounted_successfully
+-----------------------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+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 3ms (Views: 3.1ms)
+------------------------------------------------
+MountedEngineTest: test_Has_the_styleguide_route
+------------------------------------------------
+Started GET "/mountain_view/styleguide" for 127.0.0.1 at 2017-05-09 18:04:16 +0200
+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 3ms (Views: 2.6ms)

data/test/generators/extra_pages_generator_test.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ExtraPagesGeneratorTest < Rails::Generators::TestCase
+  tests MountainView::Generators::ExtraPagesGenerator
+
+  destination File.expand_path("../../tmp", __FILE__)
+  setup :prepare_destination
+
+  test "Assert all views and controller are created" do
+    # reset templates
+    Rails.application.config.app_generators.template_engine nil
+    Rails.application.config.app_generators.stylesheet_engine nil
+
+    MountainView.configuration.extra_pages = %I(grid style_status)
+    run_generator
+
+    MountainView.configuration.extra_pages.each do |page|
+      assert_file "app/views/mountain_view/extra_pages/#{page}.html.erb"
+    end
+  end
+end

data/test/test_helper.rb

@@ -16,3 +16,4 @@ end
 # for generators
 require "rails/generators/test_case"
 require "generators/mountain_view/component_generator"
+require "generators/mountain_view/extra_pages_generator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mountain_view
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Ignacio Gutierrez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2017-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -57,6 +57,7 @@ files:
 - app/assets/stylesheets/mountain_view.css.erb
 - app/assets/stylesheets/mountain_view/prism.css
 - app/assets/stylesheets/mountain_view/styleguide.css
+- app/controllers/mountain_view/extra_pages_controller.rb
 - app/controllers/mountain_view/styleguide_controller.rb
 - app/helpers/mountain_view/application_helper.rb
 - app/helpers/mountain_view/component_helper.rb
@@ -67,6 +68,8 @@ files:
 - app/views/mountain_view/styleguide/show.html.erb
 - config/routes.rb
 - lib/generators/mountain_view/component_generator.rb
+- lib/generators/mountain_view/extra_pages_generator.rb
+- lib/generators/mountain_view/mountain_view_generator_base.rb
 - lib/mountain_view.rb
 - lib/mountain_view/component.rb
 - lib/mountain_view/configuration.rb
@@ -102,6 +105,8 @@ files:
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/views/home/index.html.erb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/mountain_view/extra_pages/code_style.html.erb
+- test/dummy/app/views/mountain_view/extra_pages/grid.html.erb
 - test/dummy/bin/bundle
 - test/dummy/bin/rails
 - test/dummy/bin/rake
@@ -132,6 +137,7 @@ files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/generators/component_generator_test.rb
+- test/generators/extra_pages_generator_test.rb
 - test/helpers/mountain_view/component_helper_test.rb
 - test/integration/mounted_engine_test.rb
 - test/mountain_view/component_test.rb
@@ -194,6 +200,8 @@ test_files:
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/views/home/index.html.erb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/mountain_view/extra_pages/code_style.html.erb
+- test/dummy/app/views/mountain_view/extra_pages/grid.html.erb
 - test/dummy/bin/bundle
 - test/dummy/bin/rails
 - test/dummy/bin/rake
@@ -226,6 +234,7 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
 - test/generators/component_generator_test.rb
+- test/generators/extra_pages_generator_test.rb
 - test/helpers/mountain_view/component_helper_test.rb
 - test/integration/mounted_engine_test.rb
 - test/mountain_view/component_test.rb