komponent 1.0.0.pre.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40e0a4ef6174624542dbc86dd1c6e4013458f5c5
-  data.tar.gz: 6107b8a0dce15687071b2acc798fb88e4a704a46
+  metadata.gz: a99b2271c7cb864588a945d95ffe2bb96b1c29f8
+  data.tar.gz: 523d53f622f49450b839515dd34441087123d32c
 SHA512:
-  metadata.gz: 287bfee2642a337f11bec08f8b9c30c1dddcab28679eef865bd4411653a57d4f3d8235a2f720b46ae210f0344fbdc6bf896dd91859fff35d9ce95fefa6f6195c
-  data.tar.gz: 5ecb567ec3c60cca672aaddc42a5bfe23c9051fc74e76ac1ff8c08618e75448baaf467fed9d49ed264d38f632430847ab2273a0ff968a1bcdb693afaaf7dbb27
+  metadata.gz: 3c4501a2a63283281a76cf550c40e4544c6fe5d834c539bf3b6e88b1999a17917f6b13033cc86ee0c861e13204f296a6c22ea89ef724da4b67861728f721254e
+  data.tar.gz: 117abc530d8d1bdff4e68d63ebc43eae8eaf80babd0bc4778b91673c8edbf62c03f752410d37b545e9c49127c8741bd0d1d7c96969330a0d481d87090f98951e

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.4
+script: bundle exec cucumber

data/README.md

@@ -1,4 +1,6 @@
-# Komponent
+# <img alt="Komponent" src="https://raw.github.com/ouvrages/komponent/master/logo.svg?sanitize=true" width="200" height="40" />
+[![Build Status](https://travis-ci.org/komposable/komponent.svg?branch=master)](https://travis-ci.org/komposable/komponent)
+=======
 
 **Komponent** implements an opinionated way of organizing front-end code in Ruby on Rails, based on _components_.
 
@@ -47,6 +49,8 @@ Then, render it in your views with the `component` helper (or its alias `c`).
 = c "button"
 ```
 
+### Passing variables
+
 You can pass `locals` to the helper. They are accessible within the component partial, as instance variables.
 
 ```slim
@@ -62,6 +66,8 @@ You can pass `locals` to the helper. They are accessible within the component pa
   = @text
 ```
 
+### Passing a block
+
 The component also accepts a `block`. To render the block, just use the standard `yield`.
 
 ```slim
@@ -78,6 +84,8 @@ The component also accepts a `block`. To render the block, just use the standard
   = yield
 ```
 
+### Properties
+
 Each component comes with a Ruby `module`. You can use it to set properties:
 
 ```ruby
@@ -96,7 +104,9 @@ a.button(href=@href)
   = @text
 ```
 
-If your partial becomes a too complex and you want to remove logic from it, you may want to define custom helpers in the `ButtonComponent` module:
+### Helpers
+
+If your partial becomes too complex and you want to extract logic from it, you may want to define custom helpers in the `ButtonComponent` module:
 
 ```ruby
 # frontend/components/button/button_component.rb
@@ -125,6 +135,36 @@ a.button(href=@href)
 = component "button", text: "My button", href: "http://github.com"
 ```
 
+### Component partials
+
+You can also choose to split your component into partials. In this case, use the `render_partial` helper to render a partial, stored inside the component directory. It's a simple shorthand of the default `render` helper from Rails. 
+
+```slim
+/ frontend/components/button/_button.html.slim
+
+= a.button(href=@href)
+  = @text
+  / The line below is similar to: render("components/button/suffix", text: "external link") if external_link?
+  = render_partial("suffix", text: "external link") if external_link?
+```
+
+```slim
+/ frontend/components/button/_external_link.html.slim
+
+= " (#{text})"
+```
+
+### Namespacing components
+
+To organize different types of components, you can group them in namespaces when you use the generator:
+
+```sh
+rails generate component admin/header
+```
+
+This will create the component in an `admin` folder, and name its Ruby module `AdminHeaderComponent`.
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ouvrages/komponent.

data/komponent.gemspec

@@ -23,4 +23,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "rails", ">= 5.0"
 end

data/lib/generators/component/component_generator.rb

@@ -1,7 +1,6 @@
-class ComponentGenerator < Rails::Generators::Base
+class ComponentGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('../templates', __FILE__)
 
-  argument :component, required: true, desc: "Component name, e.g: button"
   class_option :locale, type: :boolean, default: false
 
   def create_view_file
@@ -17,7 +16,7 @@ class ComponentGenerator < Rails::Generators::Base
   end
 
   def create_rb_file
-    template "rb.erb", component_path + "#{component_name}_component.rb"
+    template "rb.erb", component_path + "#{module_name.underscore}.rb"
   end
 
   def create_locale_files
@@ -29,24 +28,62 @@ class ComponentGenerator < Rails::Generators::Base
     end
   end
 
-  def append_frontend_packs
-    append_to_file "frontend/components/index.js" do
-      "import \"components/#{component_name}/#{component_name}\";"
+  def import_to_packs
+    root_path = Pathname.new("frontend")
+    base_path = root_path + "components"
+
+    imports = []
+
+    split_name[0..-2].each do |split|
+      base_path += split
+      file_path = base_path + "index.js"
+      create_file(file_path) unless File.exists?(file_path)
+      imports << base_path.relative_path_from(root_path)
     end
+
+    root_path_dup = root_path.dup
+
+    [Pathname.new("components"), *split_name[0..-2]].each do |split|
+      root_path_dup += split
+      import = imports.shift
+      if import
+        append_to_file(root_path_dup + "index.js") do
+          "import \"#{import}\";\n"
+        end
+      end
+    end
+
+    append_to_file(base_path + "index.js") do
+      "import \"#{base_path.relative_path_from(root_path)}/#{component_name}/#{component_name}\";\n"
+    end 
   end
 
   protected
 
+  def split_name
+    name.split(/[:,::,\/]/).reject(&:blank?).map(&:underscore)
+  end
+
+  def name_with_namespace
+    split_name.join("_")
+  end
+
   def component_path
-    "frontend/components/#{component_name}/"
+    path_parts = ["frontend", "components", *split_name]
+
+    Pathname.new(path_parts.join("/"))
   end
 
   def module_name
-    "#{component_name}_component".camelize
+    "#{name_with_namespace}_component".camelize
+  end
+
+  def component_class_name
+    name_with_namespace.dasherize
   end
   
   def component_name
-    component.underscore
+    split_name.last.underscore
   end
 
   def template_engine

data/lib/generators/component/templates/css.erb

@@ -1 +1 @@
-.<%= component_name.dasherize %> {}
+.<%= component_class_name %> {}

data/lib/generators/component/templates/view.html.erb.erb

@@ -1,3 +1,3 @@
-<div class="<%= component_name.dasherize %>">
+<div class="<%= component_class_name %>">
   <%= component_name %>
 </div>

data/lib/generators/component/templates/view.html.haml.erb

@@ -1 +1 @@
-.<%= component_name.dasherize %> <%= component_name %>
+.<%= component_class_name %> <%= component_name %>

data/lib/generators/component/templates/view.html.slim.erb

@@ -1 +1 @@
-.<%= component_name.dasherize %> <%= component_name %>
+.<%= component_class_name %> <%= component_name %>

data/lib/komponent/komponent_helper.rb

@@ -41,4 +41,28 @@ module KomponentHelper
   end
 
   alias :c :component
+
+  def render_partial(partial_name, locals = {}, &block)
+    benchmark("Rendered partial #{partial_name}") do
+      context = controller.view_context
+      view_paths = context.lookup_context.view_paths.dup
+      components_path = Rails.root.join "frontend/components"
+
+      capture_block = proc { capture(&block) } if block
+
+      current_dir = Pathname.new(@virtual_path).dirname
+
+      context.lookup_context.prefixes.prepend current_dir
+      context.lookup_context.view_paths.unshift components_path
+
+      rendered_partial = capture do 
+        context.render partial_name, locals, &capture_block
+      end
+
+      context.lookup_context.prefixes.delete current_dir
+      context.lookup_context.view_paths = view_paths
+
+      rendered_partial
+    end
+  end
 end

data/lib/komponent/version.rb

@@ -1,3 +1,3 @@
 module Komponent
-  VERSION = "1.0.0.pre.2"
+  VERSION = "1.0.0"
 end

data/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 198.64 37"><title>Komponent</title><g style="fill:#0038ea;"><path d="M48.58,9.89h3.88v8.33l7.35-8.33h4.74l-7.09,7.88,7.59,10.28H60.32l-5.58-7.51L52.46,23v5.07H48.58Z"/><path d="M66.05,21.21a7.47,7.47,0,0,1,14.92,0,7.47,7.47,0,0,1-14.92,0Zm11.24,0a3.77,3.77,0,1,0-3.75,3.91A3.86,3.86,0,0,0,77.29,21.21Z"/><path d="M104.9,19.35v8.73h-3.7V20a2.54,2.54,0,1,0-5.08-.22v8.28h-3.7V20a2.53,2.53,0,1,0-5-.22v8.25H83.51V14.38h3.86v1.8a4,4,0,0,1,3.7-2.11,4.87,4.87,0,0,1,4.34,2.48,4.74,4.74,0,0,1,4.44-2.48A5,5,0,0,1,104.9,19.35Z"/><path d="M122.88,21.21c0,4.2-2.64,7.16-6.29,7.16A5.58,5.58,0,0,1,112,26.12V32.6h-3.86V14.38H112v1.91a5.64,5.64,0,0,1,4.58-2.22C120.24,14.07,122.88,17,122.88,21.21Zm-3.75,0a3.62,3.62,0,0,0-3.65-3.89A3.49,3.49,0,0,0,112,20.68v1.05a3.5,3.5,0,0,0,3.47,3.39A3.63,3.63,0,0,0,119.13,21.21Z"/><path d="M124.84,21.21a7.46,7.46,0,0,1,14.91,0,7.46,7.46,0,0,1-14.91,0Zm11.24,0a3.77,3.77,0,1,0-3.76,3.91A3.87,3.87,0,0,0,136.08,21.21Z"/><path d="M155.35,19.35v8.7h-3.73V20.17A2.6,2.6,0,0,0,149,17.32,2.71,2.71,0,0,0,146.18,20l0-.08v8.17h-3.86V14.38h3.86V16.1a4.87,4.87,0,0,1,4.13-2A5,5,0,0,1,155.35,19.35Z"/><path d="M168.2,23.74l2.46,2.52a8.33,8.33,0,0,1-5.58,2.11,7,7,0,0,1-7.24-7.19,6.88,6.88,0,0,1,7-7.11c4.29,0,6.8,3.25,6.8,8.41H161.8A3.32,3.32,0,0,0,165.06,25,4.91,4.91,0,0,0,168.2,23.74Zm-6.34-4H168A2.86,2.86,0,0,0,165,17.48,3.29,3.29,0,0,0,161.86,19.7Z"/><path d="M187.27,19.35v8.7h-3.73V20.17A2.6,2.6,0,0,0,181,17.32,2.72,2.72,0,0,0,178.09,20l0-.08v8.17h-3.86V14.38h3.86V16.1a4.87,4.87,0,0,1,4.12-2A5,5,0,0,1,187.27,19.35Z"/><path d="M198.64,27.18a5,5,0,0,1-3.15,1.19,4,4,0,0,1-4.09-4.18V17.5h-1.88V14.38h1.88V10.63h3.7v3.75h3V17.5h-3v6.09a1.4,1.4,0,0,0,1.29,1.53,2,2,0,0,0,1.32-.45Z"/><rect y="12" width="20" height="12"/></g><g style="fill:#aaa;"><rect width="10" height="12"/><rect y="24" width="10" height="13"/><rect x="20" width="10" height="12"/><rect x="20" y="24" width="10" height="13"/></g></svg>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: komponent
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Ouvrages
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-09 00:00:00.000000000 Z
+date: 2018-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: An opinionated way of organizing front-end code in Ruby on Rails, based
   on components
 email:
@@ -47,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -69,6 +112,7 @@ files:
 - lib/komponent/komponent_helper.rb
 - lib/komponent/railtie.rb
 - lib/komponent/version.rb
+- logo.svg
 homepage: http://komponent.io
 licenses:
 - MIT
@@ -84,9 +128,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13