mountain_view 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9d3b71931e79675624c362a75e20a833b8b5ea2
-  data.tar.gz: 039a5cf0da9c0f415d4da5a1ac9f4a84b71c4ae3
+  metadata.gz: 67887fb2ae93d0eac1d9885cf29dcdf662415a96
+  data.tar.gz: 6940be95e5c1c73fd4122494ab7dafb375505a80
 SHA512:
-  metadata.gz: b0ab3347848443dce35e3ec29794e60b3badca063042c4ce1f3cfce765d6fadca00acd9921e7445f76b0d9585ff6fddb366f7c807859745399d181d2257aafc2
-  data.tar.gz: 35be4d573370024634d56fc9a15d9c8aa0da8a76f565ab6fdef227399a9e9cdc4e0b7b6ea3252bbb985e092ad8715f0a2b2e9318645b9af99798d0a814445654
+  metadata.gz: c644d342583ac28525909af5d5d0cc4d437e037853017e483cdf226091d151e2f7464fdbc9afb854cf898140a1c3fc322f423daa3628e74e5a48d3ab40587861
+  data.tar.gz: 3578fc09a249f2e05afcdf37193868bb49623735d7c0595c0050b9f1501a9e34e5e2708bde9d58ace2f7e5185ddef95b26e37e91729ad9b8e5d4619a65b189ca

data/README.md

@@ -4,9 +4,13 @@
 [![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_: Does it generate it automatically? You bet!
+**FAQ**
+
+_Hey! What is a living style guide?_ A living style guide is a style guide that is always up-to-date and never falls behind.
+
+ _Does it generate it automatically?_ You bet!
 
 #### Example Style Guide
 
@@ -107,13 +111,13 @@ helper:
 You can require all the components CSS and JS automatically by requiring `mountain_view` in your main JS and CSS files.
 
 ### Global Stylesheets
-In case you want to add global stylesheets (e.g. colors.scss, fonts.scss, etc.) to your Mountain View components you can do it by calling them with an initializer
+In case you want to add global stylesheets (e.g. reset, bootstrap, a grid system, etc) to your Mountain View components you can do it by calling them with an initializer
 
 ```ruby
 #config/initializers/mountain_view.rb
 
 MountainView.configure do |config|
-  config.included_stylesheets = ["colors", "fonts"]
+  config.included_stylesheets = ["reset", "bootstrap"]
 end
 
 ```
@@ -122,6 +126,14 @@ end
 //= require mountain_view
 ```
 
+You don't need to require those again in your application if you're requiring
+`mountain_view` already, that will cause duplicate CSS.
+
+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.
+
 ## 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.
 
@@ -163,6 +175,18 @@ Visit the **<a href="https://mountain-view.herokuapp.com/mountain_view/styleguid
 
 ![mountain_view](https://cloud.githubusercontent.com/assets/623766/7099771/5b06d8da-dfd4-11e4-8558-1b7f026f28ad.gif)
 
+### Custom Routes
+
+To override the path used within the mountain_view engine, set the `styleguide_path` option.
+
+```ruby
+#config/initializers/mountain_view.rb
+
+MountainView.configure do |config|
+  config.styleguide_path = "my-style-guide"
+end
+```
+
 ## Contributing
 
 See the [contributing guide](./CONTRIBUTING.md).

data/config/routes.rb

@@ -1,5 +1,5 @@
 MountainView::Engine.routes.draw do
   root to: "styleguide#index"
 
-  resources :styleguide, only: [:index, :show]
+  resources :styleguide, only: [:index, :show], path: MountainView.configuration.styleguide_path
 end

data/lib/mountain_view/configuration.rb

@@ -1,6 +1,7 @@
 module MountainView
   class Configuration
     attr_accessor :included_stylesheets
+    attr_accessor :styleguide_path
     attr_reader :components_path
 
     def initialize

data/lib/mountain_view/version.rb

@@ -1,3 +1,3 @@
 module MountainView
-  VERSION = "0.9.1".freeze
+  VERSION = "0.10.0".freeze
 end

data/test/dummy/log/test.log

@@ -0,0 +1,150 @@
+---------------------------------------
+MountainViewTest: test_engine_is_loaded
+---------------------------------------
+------------------------------------------------------
+MountainViewTest: test_stylesheets_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2017-04-02 17:43:40 +0200
+MountainView: stylesheet not found for component 'paragraph'
+-----------------------------------------------
+MountainViewTest: test_shows_specific_component
+-----------------------------------------------
+Started GET "/mountain_view/styleguide/header" for 127.0.0.1 at 2017-04-02 17:43:40 +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.4ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (19.0ms)
+MountainView: javascript not found for component 'paragraph'
+Completed 200 OK in 80ms (Views: 80.1ms)
+-------------------------------------------------------------
+MountainViewTest: test_global_stylesheets_are_properly_served
+-------------------------------------------------------------
+Started GET "/assets/mountain_view.css" for 127.0.0.1 at 2017-04-02 17:43:40 +0200
+------------------------------------------------------
+MountainViewTest: test_javascripts_are_properly_served
+------------------------------------------------------
+Started GET "/assets/mountain_view.js" for 127.0.0.1 at 2017-04-02 17:43:40 +0200
+-------------------------------------------------------------------------------
+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-04-02 17:43:40 +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.5ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (3.5ms)
+Completed 200 OK in 6ms (Views: 5.5ms)
+-----------------------------------------------------------------------------
+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-04-02 17:43:40 +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 (7.7ms)
+Completed 200 OK in 10ms (Views: 9.7ms)
+---------------------------------------
+MountainViewTest: test_shows_styleguide
+---------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2017-04-02 17:43:40 +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 4ms (Views: 4.3ms)
+-----------------------------------------------------------------------------------
+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-04-02 17:43:40 +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.0ms)
+  Rendered /Users/kito/dev/mountain_view/app/views/mountain_view/styleguide/show.html.erb within layouts/mountain_view (0.4ms)
+Completed 200 OK in 2ms (Views: 2.3ms)
+-------------------------------------------------
+MountainViewComponentTest: test_stubs_extra_info?
+-------------------------------------------------
+--------------------------------------
+MountainViewComponentTest: test_stubs?
+--------------------------------------
+-----------------------------------------------
+MountainViewComponentTest: test_component_stubs
+-----------------------------------------------
+-----------------------------------------------------
+MountainViewComponentTest: test_stubs_correct_format?
+-----------------------------------------------------
+------------------------------------
+MountainViewComponentTest: test_name
+------------------------------------
+------------------------------------------------
+MountainViewComponentTest: test_stubs_extra_info
+------------------------------------------------
+------------------------------------------
+MountainViewComponentTest: test_stubs_file
+------------------------------------------
+-----------------------------------------------
+MountainViewComponentTest: test_humanized_title
+-----------------------------------------------
+------------------------------------------------
+MountainViewComponentTest: test_styleguide_stubs
+------------------------------------------------
+------------------------------------------------
+MountainViewComponentTest: test_component_stubs?
+------------------------------------------------
+-------------------------------------------------------------------
+MountainViewConfigurationTest: test_set_custom_included_stylesheets
+-------------------------------------------------------------------
+----------------------------------------------------------------------------
+MountainViewConfigurationTest: test_default_value_for_styleguide_path_is_nil
+----------------------------------------------------------------------------
+--------------------------------------------------------------------------------------------
+MountainViewConfigurationTest: test_default_value_for_included_stylesheets_is_an_empty_array
+--------------------------------------------------------------------------------------------
+--------------------------------------------------------------
+MountainViewConfigurationTest: test_set_custom_styleguide_path
+--------------------------------------------------------------
+------------------------------------------------------------------
+ComponentGeneratorTest: test_Assert_all_files_are_properly_created
+------------------------------------------------------------------
+--------------------------------------------------------
+ComponentGeneratorTest: test_Generates_different_engines
+--------------------------------------------------------
+-------------------------------------------------------------------------
+MountedEngineTest: test_Custom_path_can_be_applied_to_styleguide_resource
+-------------------------------------------------------------------------
+Started GET "/mountain_view/style-guide" for 127.0.0.1 at 2017-04-02 17:43:40 +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.5ms)
+-----------------------------------------------------
+MountedEngineTest: test_Has_been_mounted_successfully
+-----------------------------------------------------
+Started GET "/mountain_view" for 127.0.0.1 at 2017-04-02 17:43:40 +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.0ms)
+------------------------------------------------
+MountedEngineTest: test_Has_the_styleguide_route
+------------------------------------------------
+Started GET "/mountain_view/styleguide" for 127.0.0.1 at 2017-04-02 17:43:40 +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.2ms)
+Completed 200 OK in 2ms (Views: 2.0ms)
+--------------------------------------------------------------------
+MountainView::ComponentHelperTest: test_renders_the_proper_component
+--------------------------------------------------------------------
+  Rendered app/components/header/_header.html.erb (0.8ms)
+-----------------------------------------------------------------------------------------
+MountainView::PresenterTest: test_inherited_presenter_returns_the_default_value_for_#data
+-----------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
+MountainView::PresenterTest: test_inherited_presenter_returns_the_correct_title
+-------------------------------------------------------------------------------
+----------------------------------------------------------------
+MountainView::PresenterTest: test_exposes_properties_as_provided
+----------------------------------------------------------------
+-----------------------------------------------------------------------
+MountainView::PresenterTest: test_inherited_presenter_responds_to_#data
+-----------------------------------------------------------------------
+------------------------------------------------------------------
+MountainView::PresenterTest: test_returns_the_correct_partial_path
+------------------------------------------------------------------

data/test/integration/mounted_engine_test.rb

@@ -0,0 +1,26 @@
+class MountedEngineTest < ActionDispatch::IntegrationTest
+  test "Has been mounted successfully" do
+    get "/mountain_view"
+    assert_response :success
+  end
+
+  test "Has the styleguide route" do
+    get "/mountain_view/styleguide"
+    assert_response :success
+  end
+
+  test "Custom path can be applied to styleguide resource" do
+    styleguide_path = MountainView.configuration.styleguide_path
+
+    # Set the new path
+    MountainView.configuration.styleguide_path = "style-guide"
+    Rails.application.reload_routes!
+
+    get "/mountain_view/style-guide"
+    assert_response :success
+
+    # Reset back to original
+    MountainView.configuration.styleguide_path = styleguide_path
+    Rails.application.reload_routes!
+  end
+end

data/test/mountain_view/configuration_test.rb

@@ -5,10 +5,21 @@ class MountainViewConfigurationTest < ActiveSupport::TestCase
     assert_equal MountainView::Configuration.new.included_stylesheets, []
   end
 
+  test "default value for styleguide_path is nil" do
+    assert_nil MountainView::Configuration.new.styleguide_path
+  end
+
   test "set custom included_stylesheets" do
     config = MountainView::Configuration.new
     config.included_stylesheets = ["global", "fonts"]
 
     assert_equal config.included_stylesheets, ["global", "fonts"]
   end
+
+  test "set custom styleguide_path" do
+    config = MountainView::Configuration.new
+    config.styleguide_path = "style-guide"
+
+    assert_equal config.styleguide_path, "style-guide"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mountain_view
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Ignacio Gutierrez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-31 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,12 +122,14 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
+- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/generators/component_generator_test.rb
 - test/helpers/mountain_view/component_helper_test.rb
+- test/integration/mounted_engine_test.rb
 - test/mountain_view/component_test.rb
 - test/mountain_view/configuration_test.rb
 - test/mountain_view/presenter_test.rb
@@ -157,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Mountain View helps you create reusable visual components on your Rails Application.
@@ -208,6 +210,7 @@ test_files:
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
 - test/dummy/config.ru
+- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -216,6 +219,7 @@ test_files:
 - test/dummy/README.rdoc
 - test/generators/component_generator_test.rb
 - test/helpers/mountain_view/component_helper_test.rb
+- test/integration/mounted_engine_test.rb
 - test/mountain_view/component_test.rb
 - test/mountain_view/configuration_test.rb
 - test/mountain_view/presenter_test.rb