mountain_view 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83f60d5460852f2b3da478f9e0b26a5086eddaa4
-  data.tar.gz: 72f7885a1f190095646f6d4ec09f3abcc719141f
+  metadata.gz: 7e507562df73309d3251a7b7d4a3c12c8fc42c26
+  data.tar.gz: 3c74a87d9e0ae9b84aaf1b81d5917af054062f28
 SHA512:
-  metadata.gz: c887c08827b419b6c2c674ccbae3d4aef524565430d2fca40d0eb45d79e75a4e1aa050b07fabd2d71ebca512930a95da208ea26e85ec656bc03798d6eda637eb
-  data.tar.gz: b20d3e97269e455e7859da4e48e0f7898d8fdbabd1e8c169c13210a0ee15ee663aee6aa5a2d7577f6c3ed424170a3ccf19816c45f2580277dd79098d1a7ab8b7
+  metadata.gz: 70cceab5e5b95b321ac3e3566076e2591f275697f307fc2ecd7c3005508052e908f32a4c2791a0108402537d8f0226af9dc5b41b2a13cfd56c9811e92ad9ea53
+  data.tar.gz: 03c34700700d0b959212f95ac163cfc18bde9865138753ac1ad9f42dd362a65e995ce9ebf4f9e383a4837732536a607a7e2e818d8f3427f2d0abe5b52b498346

data/README.md

@@ -26,6 +26,8 @@ Then execute:
 
     $ bundle
 
+Mountain View supports Ruby 2.0+.
+
 ## Usage
 
 Use the built-in generator to create a new component:
@@ -44,6 +46,7 @@ app/
       header.css
       header.js
       header.yml
+      header_component.rb # optional
 ```
 
 Keep in mind that you can also use `scss`, `coffeescript`, `haml`, or any other
@@ -58,11 +61,40 @@ coffee-script as long as you have these preprocessors running on your app.
 ```erb
 <!-- app/components/header/_header.html.erb -->
 <div class="header">
-  <h1>This is a header component with the title: <%= properties[:title] %></h1>
-  <h3>And subtitle <%= properties[:subtitle] %></h3>
+  <h1>This is a header component with the title: <%= title %></h1>
+  <h3>And subtitle <%= subtitle %></h3>
+  <% if show_links? %>
+    <ul>
+      <% links.each do |link| %>
+        <li><%= link %></li>
+      <% end %>
+    </ul>
+  <% end %>
 </div>
 ```
 
+```ruby
+# app/components/header/header_component.rb
+class HeaderComponent < MountainView::Presenter
+  properties :title, :subtitle
+  property :links, default: []
+
+  def title
+    properties[:title].titleize
+  end
+
+  def show_links?
+    links.any?
+  end
+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 
+component class and views. You can even define property defaults.
+
 ### Using components on your views
 You can then call your components on any view by using the following
 helper:

data/app/assets/javascripts/mountain_view.js.erb

@@ -1,4 +1,4 @@
-<% if Dir.exists?(MountainView.configuration.components_path) %>
+<% if Dir.exist?(MountainView.configuration.components_path) %>
   <% depend_on MountainView.configuration.components_path.to_s %>
   <% Dir.glob(MountainView.configuration.components_path.join('*')).each do |component_dir|
     component = File.basename component_dir

data/app/assets/stylesheets/mountain_view.css.erb

@@ -1,7 +1,7 @@
 <% MountainView.configuration.included_stylesheets.each do |included_stylesheet| %>
   <%= require_asset included_stylesheet %>
 <% end %>
-<% if Dir.exists?(MountainView.configuration.components_path) %>
+<% if Dir.exist?(MountainView.configuration.components_path) %>
   <% depend_on MountainView.configuration.components_path.to_s %>
   <% Dir.glob(MountainView.configuration.components_path.join('*')).each do |component_dir|
     component = File.basename component_dir

data/app/helpers/mountain_view/component_helper.rb

@@ -1,7 +1,8 @@
 module MountainView
   module ComponentHelper
     def render_component(slug, properties = {})
-      render "#{slug}/#{slug}", properties: properties
+      component = MountainView::Presenter.component_for(slug, properties)
+      component.render(controller.view_context)
     end
   end
 end

data/lib/mountain_view.rb

@@ -1,5 +1,7 @@
 require "mountain_view/version"
 require "mountain_view/configuration"
+require "mountain_view/presenter"
+require "mountain_view/component"
 
 module MountainView
   def self.configuration

data/lib/mountain_view/engine.rb

@@ -1,6 +1,4 @@
 require "rails"
-require "mountain_view"
-require "mountain_view/component"
 
 module MountainView
   class Engine < ::Rails::Engine
@@ -12,6 +10,12 @@ module MountainView
       end
     end
 
+    initializer "mountain_view.load_component_classes",
+                before: :set_autoload_paths do |app|
+      component_paths = "#{MountainView.configuration.components_path}/{*}"
+      app.config.autoload_paths += Dir[component_paths]
+    end
+
     initializer "mountain_view.assets" do |app|
       Rails.application.config.assets.paths <<
         MountainView.configuration.components_path

data/lib/mountain_view/presenter.rb

@@ -0,0 +1,77 @@
+module MountainView
+  class Presenter
+    class_attribute :_properties, instance_accessor: false
+    self._properties = {}
+
+    attr_reader :slug, :properties
+
+    def initialize(slug, properties = {})
+      @slug = slug
+      @properties = default_properties.deep_merge(properties)
+    end
+
+    def render(context)
+      context.extend ViewContext
+      context.inject_component_context self
+      context.render partial: partial
+    end
+
+    def partial
+      "#{slug}/#{slug}"
+    end
+
+    private
+
+    def default_properties
+      self.class._properties.inject({}) do |sum, (k, v)|
+        sum[k] = v[:default]
+        sum
+      end
+    end
+
+    class << self
+      def component_for(*args)
+        klass = "#{args.first.to_s.camelize}Component".safe_constantize
+        klass ||= self
+        klass.new(*args)
+      end
+
+      def properties(*args)
+        opts = args.extract_options!
+        properties = args.inject({}) do |sum, name|
+          sum[name] = opts
+          sum
+        end
+        define_property_methods(args)
+        self._properties = _properties.merge(properties)
+      end
+      alias_method :property, :properties
+
+      private
+
+      def define_property_methods(names = [])
+        names.each do |name|
+          next if method_defined?(name)
+          define_method name do
+            properties[name.to_sym]
+          end
+        end
+      end
+    end
+
+    module ViewContext
+      attr_reader :_component
+      delegate :properties, to: :_component
+
+      def inject_component_context(component)
+        @_component = component
+        protected_methods = MountainView::Presenter.public_methods(false)
+        methods = component.public_methods(false) - protected_methods
+        methods.each do |meth|
+          next if self.class.method_defined?(meth)
+          self.class.delegate meth, to: :_component
+        end
+      end
+    end
+  end
+end

data/lib/mountain_view/version.rb

@@ -1,3 +1,3 @@
 module MountainView
-  VERSION = "0.8.1".freeze
+  VERSION = "0.9.0".freeze
 end

data/test/dummy/app/components/card/_card.html.erb

@@ -7,11 +7,12 @@
   <% end %>
   <div class="card__content">
     <h3 class="card__content__title">
-      <a href="<%= properties[:link] %>"><%= properties[:title] %></a>
+      <a href="<%= properties[:link] %>"><%= title %></a>
     </h3>
-    <%- if properties[:description] %>
+    <%- if has_description? %>
       <p><%= properties[:description] %></p>
     <%- end %>
+    <p>Location: <%= location %></p>
     <div class="card__content__data">
       <%- if properties[:data] && properties[:data].any? %>
         <%- properties[:data].each do |data| %>
@@ -23,4 +24,4 @@
       <% end %>
     </div>
   </div>
-</div>
+</div>

data/test/dummy/app/components/card/card.yml

@@ -1,5 +1,6 @@
 -
-  :title: "Aspen Snowmass"
+  :title: "Snowmass"
+  :location: "Aspen"
   :description: "Aspen Snowmass is a winter resort complex located in Pitkin County in western Colorado in the United States. Owned and operated by the Aspen Skiing Company it comprises four skiing/snowboarding areas on four adjacent mountains in the vicinity of the towns of Aspen and Snowmass Village."
   :link: "http://google.com"
   :image_url: "http://i.imgur.com/QzuIJTo.jpg"
@@ -13,7 +14,8 @@
 
 
 -
-  :title: "Breckenridge, Colorado"
+  :title: "Breckenridge"
+  :location: "Colorado"
   :link: "http://facebook.com"
   :image_url: "http://i.imgur.com/w7ZyWPg.jpg"
   :data:

data/test/dummy/app/components/card/card_component.rb

@@ -0,0 +1,14 @@
+class CardComponent < MountainView::Presenter
+  include ActionView::Helpers::TagHelper
+
+  properties :title, :description, :link, :image_url, :location
+  property :data, default: []
+
+  def title
+    [location, properties[:title]].compact.join(", ")
+  end
+
+  def has_description?
+    description.present?
+  end
+end

data/test/generators/component_generator_test.rb

@@ -7,14 +7,17 @@ class ComponentGeneratorTest < Rails::Generators::TestCase
   setup :prepare_destination
 
   test "Assert all files are properly created" do
+    # reset engines
+    Rails.application.config.app_generators.template_engine nil
+    Rails.application.config.app_generators.stylesheet_engine nil
+    Rails.application.config.app_generators.javascript_engine nil
+
     run_generator %w( widget )
 
     assert_file "app/components/widget/_widget.html.erb"
     assert_file "app/components/widget/widget.css"
     assert_file "app/components/widget/widget.js"
     assert_file "app/components/widget/widget.yml"
-    # Delete generated files so the test don't fail if the order is random
-    FileUtils.remove_dir(File.expand_path("../../tmp", __FILE__))
   end
 
   test "Generates different engines" do
@@ -28,7 +31,5 @@ class ComponentGeneratorTest < Rails::Generators::TestCase
     assert_file "app/components/widget/widget.scss"
     assert_file "app/components/widget/widget.coffee"
     assert_file "app/components/widget/widget.yml"
-    # Delete generated files so the test don't fail if the order is random
-    FileUtils.remove_dir(File.expand_path("../../tmp", __FILE__))
   end
 end

data/test/helpers/mountain_view/component_helper_test.rb

@@ -7,6 +7,6 @@ class MountainView::ComponentHelperTest < ActionView::TestCase
     expected = /Pepe/
 
     assert_match expected, rendered
-    assert_match /href=\"\/products\/1\"/, rendered
+    assert_match %r(href=\"\/products\/1\"), rendered
   end
 end

data/test/mountain_view/presenter_test.rb

@@ -0,0 +1,38 @@
+require "test_helper"
+
+class InheritedPresenter < MountainView::Presenter
+  properties :title, :description
+  property :data, default: []
+
+  def title
+    "Foo#{properties[:title].downcase}"
+  end
+end
+
+class MountainView::PresenterTest < ActiveSupport::TestCase
+  test "returns the correct partial path" do
+    presenter = MountainView::Presenter.new("header")
+    assert_equal "header/header", presenter.partial
+  end
+
+  test "exposes properties as provided" do
+    properties = { foo: "bar", hello: "world" }
+    presenter = MountainView::Presenter.new("header", properties)
+    assert_equal properties, presenter.properties
+  end
+
+  test "inherited presenter returns the correct title" do
+    presenter = InheritedPresenter.new("inherited", title: "Bar")
+    assert_equal "Foobar", presenter.title
+  end
+
+  test "inherited presenter responds to #data" do
+    presenter = InheritedPresenter.new("inherited", data: ["Foobar"])
+    assert_equal ["Foobar"], presenter.data
+  end
+
+  test "inherited presenter returns the default value for #data" do
+    presenter = InheritedPresenter.new("inherited", {})
+    assert_equal [], presenter.data
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mountain_view
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Ignacio Gutierrez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-06 00:00:00.000000000 Z
+date: 2016-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -71,6 +71,7 @@ files:
 - lib/mountain_view/component.rb
 - lib/mountain_view/configuration.rb
 - lib/mountain_view/engine.rb
+- lib/mountain_view/presenter.rb
 - lib/mountain_view/version.rb
 - lib/tasks/mountain_view_tasks.rake
 - test/dummy/README.rdoc
@@ -86,6 +87,7 @@ files:
 - test/dummy/app/components/card/card.css
 - test/dummy/app/components/card/card.js
 - test/dummy/app/components/card/card.yml
+- test/dummy/app/components/card/card_component.rb
 - test/dummy/app/components/header/_header.html.erb
 - test/dummy/app/components/header/header.css
 - test/dummy/app/components/header/header.js
@@ -128,6 +130,7 @@ files:
 - test/helpers/mountain_view/component_helper_test.rb
 - test/mountain_view/component_test.rb
 - test/mountain_view/configuration_test.rb
+- test/mountain_view/presenter_test.rb
 - test/mountain_view_test.rb
 - test/test_helper.rb
 - test/tmp/app/components/widget/_widget.html.haml
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Mountain View helps you create reusable visual components on your Rails Application.
@@ -170,6 +173,7 @@ test_files:
 - test/dummy/app/components/card/card.css
 - test/dummy/app/components/card/card.js
 - test/dummy/app/components/card/card.yml
+- test/dummy/app/components/card/card_component.rb
 - test/dummy/app/components/header/_header.html.erb
 - test/dummy/app/components/header/header.css
 - test/dummy/app/components/header/header.js
@@ -214,6 +218,7 @@ test_files:
 - test/helpers/mountain_view/component_helper_test.rb
 - test/mountain_view/component_test.rb
 - test/mountain_view/configuration_test.rb
+- test/mountain_view/presenter_test.rb
 - test/mountain_view_test.rb
 - test/test_helper.rb
 - test/tmp/app/components/widget/_widget.html.haml