RubyGems - komponent - Versions diffs - 2.2.0 → 3.0.0.beta1 - Mend

komponent 2.2.0 → 3.0.0.beta1

Files changed (58) hide show

data/app/views/komponent/styleguide/index.html.erb ADDED

@@ -0,0 +1,9 @@
+<h1>Styleguide</h1>
+<% if components.any? %>
+  <p>Select one of the components from the side to view its examples and documentation.</p>
+<% else %>
+  <p><<strong>Hint:</strong> You haven't created any component yet</h2>
+  <p>You can generate your first component by running:</p>
+  <pre>rails generate component component-name</pre>
+<% end %>

data/app/views/komponent/styleguide/missing_template.html.erb ADDED

@@ -0,0 +1,3 @@
+<h1>Examples missing</h1>
+<p>Please create <code><%= @component.path %>/_examples.html.<%= Rails.application.config.app_generators.rails[:template_engine] || :erb %></code> file.</p>

data/app/views/komponent/styleguide/show.html.erb ADDED

	@@ -0,0 +1 @@
1	+ <%= render partial: @component.examples_view %>

data/app/views/layouts/komponent.html.erb ADDED

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Styleguide</title>
+  <%= javascript_pack_tag 'komponent' %>
+  <%= stylesheet_pack_tag 'komponent', media: 'all' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <%= c 'komponent/header' %>
+  <%= c 'komponent/sidebar' %>
+  <%= c 'komponent/container' do %>
+    <%= yield %>
+  <% end %>
+  <%= c 'komponent/footer' %>
+</body>
+</html>

data/config/routes.rb ADDED

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+Komponent::Engine.routes.draw do
+  resources :styleguide, only: %i[index show]
+end

data/komponent.gemspec CHANGED

@@ -23,16 +23,17 @@ Gem::Specification.new do |spec|
   }
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|fixtures)/})
+    f.match(%r{^(test|spec|features|fixtures|gemfiles)/})
   end
   spec.require_paths = ["lib"]
   spec.required_ruby_version = '>= 2.2.0'
-  spec.add_dependency "actionview", ">= 4.2"
-  spec.add_dependency "activesupport", ">= 4.2"
-  spec.add_dependency "railties", ">= 4.2"
+  spec.add_dependency "actionview", ">= 5.0"
+  spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "railties", ">= 5.0"
   spec.add_dependency "webpacker", ">= 3.0.0"
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler", "~> 2.0.1"
 end

data/lib/generators/component/component_generator.rb CHANGED

@@ -34,6 +34,10 @@ class ComponentGenerator < Rails::Generators::NamedBase
     end
   end
+  def create_examples_view_file
+    template "examples.html.#{template_engine}.erb", component_path + "_examples.html.#{template_engine}"
+  end
   def import_to_packs
     root_path = default_path
     base_path = root_path + "components"
@@ -169,14 +173,26 @@ class ComponentGenerator < Rails::Generators::NamedBase
   end
   def sort_lines_alphabetically!(path)
+    relative_imports, imports = read_imports_from_path(path)
+    return if imports.empty?
+    imports = imports.uniq.sort + relative_imports
+    write_imports_to_path(imports, path)
+  end
+  def read_imports_from_path(path)
     lines = File.readlines(path).map do |line|
       line if line =~ /^import ["'](.*)["'];$/
     end.compact
-    return if lines.empty?
-    lines = lines.uniq.sort
+    lines.partition do |l|
+      l =~ /^import ["']\.(.*)["'];$/
+    end
+  end
+  def write_imports_to_path(lines, path)
     File.open(path, "w") do |f|
       lines.each do |line|
         f.write(line)

data/lib/generators/component/templates/examples.html.erb.erb ADDED

@@ -0,0 +1,3 @@
+<h1><%= @component_name %></h1>
+<%%= cdoc "<%= component_name %>" %>

data/lib/generators/component/templates/examples.html.haml.erb ADDED

@@ -0,0 +1,3 @@
+%h1 <%= @component_name %>
+= cdoc "<%= component_name %>"

data/lib/generators/component/templates/examples.html.slim.erb ADDED

@@ -0,0 +1,3 @@
+h1 <%= @component_name %>
+= cdoc "<%= component_name %>"

data/lib/generators/component/templates/stimulus_view.html.haml.erb CHANGED

@@ -1,4 +1,4 @@
-.<%= component_class_name %>{'data-controller': "<%= component_class_name %>", class: "<%= component_class_name %>"}
+.<%= component_class_name %>{ data: { controller: '<%= component_class_name %>' } }
   <%- if locale? -%>
   = t ".component_name"
   <%- else -%>

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

@@ -1,4 +1,4 @@
-.<%= component_class_name %>{class: "<%= component_class_name %>"}
+.<%= component_class_name %>
   <%- if locale? -%>
   = t ".component_name"
   <%- else -%>

data/lib/generators/komponent/examples_generator.rb ADDED

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'komponent/component'
+require File.expand_path('../utils', __FILE__)
+module Komponent
+  module Generators
+    class ExamplesGenerator < Rails::Generators::Base
+      include Utils
+      source_root File.expand_path('../../component/templates', __FILE__)
+      def create_examples_files
+        Komponent::Component.all.each do |name, component|
+          create_examples_view_file(name)
+        end
+      end
+      protected
+      def split_name(name)
+        name.split(/[:,::,\/]/).reject(&:blank?).map(&:underscore)
+      end
+      def component_path(component_name)
+        path_parts = [default_path, 'components', *split_name(component_name)]
+        Pathname.new(path_parts.join('/'))
+      end
+      private
+      def create_examples_view_file(component_name)
+        @component_name = split_name(component_name).last.underscore
+        template "examples.html.#{template_engine}.erb", component_path(component_name) + "_examples.html.#{template_engine}"
+      end
+    end
+  end
+end

data/lib/generators/komponent/install_generator.rb CHANGED

@@ -1,51 +1,51 @@
 # frozen_string_literal: true
+require 'rails/generators'
 module Komponent
   module Generators
     class InstallGenerator < Rails::Generators::Base
       class_option :stimulus, type: :boolean, default: false
+      source_root File.join(File.dirname(__FILE__), "templates")
-      def check_webpacker_dependency
-        return if komponent_already_installed?
-        unless File.exist?(webpacker_configuration_file) and File.directory?(webpacker_default_structure)
-          raise Thor::Error, dependencies_not_met_error_message
-        end
-      end
-      def create_root_directory
-        return if File.directory?(komponent_root_directory)
-        empty_directory(komponent_root_directory)
+      def check_webpacker_installed
+        return if File.directory?(komponent_directory)
+        installed = File.exist?(webpacker_configuration_file)
+        raise Thor::Error, dependencies_not_met_error_message unless installed
       end
-      def modify_webpacker_configuration
-        gsub_file(webpacker_configuration_file, /source_path: app\/javascript$/, "source_path: #{relative_path_from_rails}")
+      def create_komponent_directory
+        empty_directory(komponent_directory)
+        directory(
+          javascript_directory,
+          komponent_directory,
+          recursive: true,
+        )
       end
-      def move_webpacker_default_structure
-        return if File.directory?(komponent_root_directory)
-        run("mv #{webpacker_default_structure}/* #{komponent_root_directory}")
+      def alter_webpacker_configuration
+        gsub_file(
+          webpacker_configuration_file,
+          /source_path: app\/javascript$/,
+          "source_path: #{komponent_directory}",
+        )
       end
       def create_komponent_default_structure
-        return if File.exist?(components_directory.join("index.js"))
+        return if File.exist?(join(components_directory, "index.js"))
         empty_directory(components_directory)
-        create_file(components_directory.join("index.js"))
+        create_file(join(components_directory, "index.js"))
       end
       def create_stimulus_file
         return if File.exist?(stimulus_application_path)
         return unless stimulus?
         create_file(stimulus_application_path, stimulus_application_template)
       end
       def append_to_application_configuration
-        application "config.autoload_paths << config.root.join('#{relative_path_from_rails}/components')"
-        application "config.i18n.load_path += Dir[config.root.join('#{relative_path_from_rails}/components/**/*.yml')]"
+        application "config.autoload_paths << config.root.join('#{komponent_directory}/components')"
+        application "config.i18n.load_path += Dir[config.root.join('#{komponent_directory}/components/**/*.*.yml')]"
       end
       def append_to_application_pack
@@ -73,31 +73,27 @@ export default application;
       end
       def stimulus_application_path
-        komponent_root_directory.join("stimulus_application.js")
+        join(komponent_directory, "stimulus_application.js")
       end
       def application_pack_path
-        komponent_root_directory.join("packs", "application.js")
-      end
-      def komponent_root_directory
-        default_path
+        join(komponent_directory, "packs", "application.js")
       end
       def components_directory
-        Rails.root.join(komponent_root_directory, "components")
+        join(komponent_directory, "components")
       end
-      def webpacker_configuration_file
-        Rails.root.join("config", "webpacker.yml")
+      def komponent_directory
+        default_path
       end
-      def webpacker_default_structure
-        Rails.root.join("app", "javascript")
+      def webpacker_configuration_file
+        join("config", "webpacker.yml")
       end
-      def komponent_already_installed?
-        File.directory?(relative_path_from_rails)
+      def javascript_directory
+        join("app", "javascript")
       end
       def dependencies_not_met_error_message
@@ -113,10 +109,6 @@ export default application;
         rails_configuration.komponent.root
       end
-      def relative_path_from_rails
-        default_path.relative_path_from(Rails.root)
-      end
       private
       def komponent_configuration
@@ -133,6 +125,10 @@ export default application;
       def app_generators
         rails_configuration.app_generators
       end
+      def join(*paths)
+        File.expand_path(File.join(*paths), destination_root)
+      end
     end
   end
 end

data/lib/generators/komponent/styleguide_generator.rb ADDED

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require File.expand_path('../utils', __FILE__)
+module Komponent
+  module Generators
+    class StyleguideGenerator < Rails::Generators::Base
+      include Utils
+      source_root File.expand_path('../templates/styleguide', __FILE__)
+      def check_komponent_dependency
+        unless komponent_already_installed?
+          raise Thor::Error, dependencies_not_met_error_message
+        end
+      end
+      def copy_styleguide_components
+        directory 'components', components_directory.join('komponent')
+      end
+      def create_komponent_pack
+        template 'packs/komponent.js', komponent_pack_path
+      end
+      def append_to_application_routes
+        route 'mount Komponent::Engine => \'/\' if Rails.env.development?'
+      end
+      protected
+      def komponent_pack_path
+        komponent_root_directory.join('packs', 'komponent.js')
+      end
+      def dependencies_not_met_error_message
+        'Seems you don\'t have komponent installed in your project. Please install komponent, and follow instructions at https://github.com/komposable/komponent'
+      end
+    end
+  end
+end

data/lib/generators/komponent/templates/styleguide/components/container/_komponent_container.html.erb ADDED

@@ -0,0 +1,3 @@
+<div class="komponent-container">
+  <%= yield %>
+</div>

data/lib/generators/komponent/templates/styleguide/components/container/komponent_container.css ADDED

@@ -0,0 +1,17 @@
+/* stylelint-disable value-list-comma-newline-after */
+.komponent-container {
+  font-size: 16px;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
+    Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
+  margin: 40px 60px 0 300px;
+  .komponent-code {
+    background-color: #333;
+    color: #fff;
+    margin: 10px 0;
+    padding: 10px;
+  }
+}
+/* stylelint-enable */

data/lib/generators/komponent/templates/styleguide/components/container/komponent_container.js ADDED

	@@ -0,0 +1 @@
1	+ import "./komponent_container.css";

data/lib/generators/komponent/templates/styleguide/components/container/komponent_container_component.rb ADDED

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module KomponentContainerComponent
+  extend ComponentHelper
+end

data/lib/generators/komponent/templates/styleguide/components/footer/_komponent_footer.html.erb ADDED

@@ -0,0 +1,3 @@
+<div class="komponent-footer">
+  Built with <%= link_to "Komponent", "http://komponent.io", target: "_blank" %>
+</div>

data/lib/generators/komponent/templates/styleguide/components/footer/komponent_footer.css ADDED

@@ -0,0 +1,27 @@
+/* stylelint-disable value-list-comma-newline-after */
+.komponent-footer {
+  bottom: 30px;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
+    Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
+  font-size: 14px;
+  position: fixed;
+  right: 30px;
+  text-align: center;
+  &,
+  a {
+    color: #999;
+  }
+  a {
+    text-decoration: none;
+    &:hover,
+    &:focus {
+      color: #0038ea;
+    }
+  }
+}
+/* stylelint-enable */

data/lib/generators/komponent/templates/styleguide/components/footer/komponent_footer.js ADDED

	@@ -0,0 +1 @@
1	+ import "./komponent_footer.css";

data/lib/generators/komponent/templates/styleguide/components/footer/komponent_footer_component.rb ADDED

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module KomponentFooterComponent
+  extend ComponentHelper
+end

data/lib/generators/komponent/templates/styleguide/components/header/_komponent_header.html.erb ADDED

@@ -0,0 +1,3 @@
+<div class="komponent-header">
+  <div class="logo">Styleguide</div>
+</div>

data/lib/generators/komponent/templates/styleguide/components/header/komponent_header.css ADDED

@@ -0,0 +1,15 @@
+/* stylelint-disable value-list-comma-newline-after */
+.komponent-header {
+  align-items: center;
+  background-color: #0038ea;
+  color: white;
+  display: flex;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
+    Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
+  font-size: 16px;
+  height: 60px;
+  padding: 0 20px;
+}
+/* stylelint-enable */