komponent 2.2.0 → 3.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3e2bae47fbc3e0bfcce014af0c87f14a34ab714c
-  data.tar.gz: 8ccf2d57342494ecfb6e45eb4db627b70fde7f7a
+SHA256:
+  metadata.gz: 771cfe13a6b0819f90aa68ca915ab8ae03103d24059e78b80daf4a8aeb8d04bd
+  data.tar.gz: 470dd7ad644217fd257f30d0e267951e8520041cf0e9acbf274a7377fcd52fc1
 SHA512:
-  metadata.gz: a77641b9e00d24bcf7ca35a5c7788abcfde90564864c8020840d9a49a73437fa8af1f9904f2dea2623243c4b53ef115f25239612f2fa0fa0aabbddfb20d66094
-  data.tar.gz: a50699a3015564a76b88665aeef7e8b45e3f928e1cdb8547754141cd800ca755ddf7b944705f8fe55808528c75d7049a765cd16ff67595a20db76a27c7cb943f
+  metadata.gz: ec526ec6e340a674101e894944ad486155a77db9516e2f45b9778ed925c8cc9e05193f3b5d4e11144c30f9b33376de07960053b8020ed532a4ee4d1d773cac8f
+  data.tar.gz: c74cb8685aeb47b9ee9275e22fc9f5dafe56bc5b58644207954ab5fecd9e192464859908d55cc878f3afd42e349a739fcbc6c7b2622165e086d37f03ff4eebad

data/.editorconfig

@@ -0,0 +1,14 @@
+; top-most EditorConfig file
+root = true
+
+; Unix-style newlines
+[*]
+end_of_line = LF
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -7,6 +7,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/test/tmp
 
 /fixtures/my_app/tmp
 /fixtures/my_app/log
+

data/.rubocop.yml

@@ -2,10 +2,13 @@ AllCops:
   TargetRubyVersion: 2.2
   DisabledByDefault: true
   Exclude:
-    - 'node_modules/**/*'
-    - 'vendor/**/*'
-    - 'tmp/**/*'
-    - 'fixtures/**/*'
+    - node_modules/**/*
+    - vendor/**/*
+    - tmp/**/*
+    - fixtures/**/*
+    - Appraisals
+    - gemfiles/**/*
+    - test/tmp/**/*
 
 Gemspec/OrderedDependencies:
   Enabled: true
@@ -52,9 +55,6 @@ Naming/PredicateName:
 Naming/VariableName:
   Enabled: true
 
-Lint/DeprecatedClassMethods:
-  Enabled: true
-
 Layout/AlignParameters:
   Enabled: true
 
@@ -115,3 +115,6 @@ Layout/SpaceInsideParens:
 
 Layout/TrailingWhitespace:
   Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true

data/.travis.yml

@@ -5,23 +5,22 @@ before_install:
   - gem update --system
 
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5
   - ruby-head
 
 gemfile:
-  - Gemfile-rails.4.2.x
-  - Gemfile-rails.5.0.x
-  - Gemfile-rails.5.1.x
-  - Gemfile-rails.5.2.x
+  - gemfiles/rails_5.0.x.gemfile
+  - gemfiles/rails_5.1.x.gemfile
+  - gemfiles/rails_5.2.x.gemfile
 
 cache:
   bundler: true
   yarn: true
 
 install:
+  - gem install bundler
   - bundle install
   - nvm install node
   - node -v

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails-5.0.x" do
+  gem "rails", "~> 5.0"
+end
+
+appraise "rails-5.1.x" do
+  gem "rails", "~> 5.1"
+end
+
+appraise "rails-5.2.x" do
+  gem "rails", "~> 5.2"
+end
+
+appraise "rails-6.0.x" do
+  gem "rails", "~> 6.0.0.beta1"
+end

data/CHANGELOG.md

@@ -2,13 +2,31 @@
 
 ## Upcoming release
 
+## v3.0.0.beta1 (2019-02-28)
+
+**Breaking changes:**
+- Dropped support for Rails 4.2
+- Dropped support for Ruby 2.2
+
+**Enhancements:**
+- Komponent now reports component stats when you run `bin/rails stats`
+- Komponent now includes a styleguide engine that you can mount to your project
+  to document your components, and 2 new generators:
+  - `rails g komponent:styleguide` to set it up
+  - `rails g komponent:examples` to generate an `examples` file for each existing component
+
+**Bug fixes:**
+- Removed redundant `class` attribute in HAML templates
+- Fix `content_for` / `yield` which was no longer working across components, since `v2.0.0`
+- Fix translation key lookup in partials (helper method `t`)
+
 ## v2.2.0 (2018-07-03)
 
 **Enhancements:**
 - Component generator: use `component_name` instead of `module_name` in templates,
   so when we create a `button` component, by default it contains `button` instead
   of `button_component`
-  
+
 **Bug fixes:**
 - Component generator: fix error when the single-quotes are used in `import`s
 

data/Gemfile

@@ -10,6 +10,7 @@ gemspec
 gem "rails"
 gem "rake", ">= 11.1"
 gem "rubocop", require: false
+gem "webpacker"
 
 group :test do
   gem "aruba"

data/README.md

@@ -34,6 +34,7 @@ This gem has been inspired by our Rails development practices at [Ouvrages](http
   - [Stimulus integration](#stimulus-integration)
   - [Internationalization](#internationalization)
     - [Available locales configuration](#available-locales-configuration)
+  - [Styleguide](#styleguide)
   - [Configuration](#configuration)
     - [Change default root path](#change-default-root-path)
     - [Default options for the generators](#default-options-for-the-generators)
@@ -41,13 +42,14 @@ This gem has been inspired by our Rails development practices at [Ouvrages](http
     - [Force default templating engine](#force-default-templating-engine)
     - [Additional paths](#additional-paths)
 - [Contributing](#contributing)
+- [Releasing a new version](#releasing-a-new-version)
 - [License](#license)
 </details>
 
 ## Compatibility
 
 - Ruby 2.2+
-- Rails 4.2+
+- Rails 5.0+
 - Webpacker 3.0.0+
 
 ## Getting started
@@ -55,7 +57,7 @@ This gem has been inspired by our Rails development practices at [Ouvrages](http
 ```ruby
 # Gemfile
 
-gem "komponent"
+gem 'komponent'
 ```
 
 Run the following command to set up your project instantly:
@@ -84,8 +86,8 @@ Then, render it in your views with the `component` helper (or its alias `c`).
 ```slim
 / app/views/pages/home.html.slim
 
-= component "button"
-= c "button"
+= component 'button'
+= c 'button'
 ```
 
 Or, directly from your controllers:
@@ -94,7 +96,7 @@ Or, directly from your controllers:
 # app/controllers/pages_controller.rb
 
 def home
-  render html: helpers.component("home")
+  render html: helpers.component('home')
 end
 ```
 
@@ -106,11 +108,11 @@ Make sure to include javascript pack tag and stylesheet pack tag in your applica
 doctype html
 html
   head
-    = stylesheet_pack_tag "application"
+    = stylesheet_pack_tag 'application'
 
   body
     = yield
-    = javascript_pack_tag "application"
+    = javascript_pack_tag 'application'
 ```
 
 Check [Webpacker documentation](https://github.com/rails/webpacker) for further information.
@@ -122,7 +124,7 @@ You can pass `locals` to the helper. They are accessible within the component pa
 ```slim
 / app/views/pages/home.html.slim
 
-= component "button", text: "My button"
+= component 'button', text: 'My button'
 ```
 
 ```slim
@@ -145,10 +147,10 @@ If you want better control of the cache expiration, you can provide a custom `ca
 / app/views/pages/home.html.slim
 
 / Cache the component based on its locals
-= component "button", { text: "Click here" }, cached: true
+= component "button", { text: 'Click here' }, cached: true
 
 / or cache the component with a specific key, such as the last update of a model
-= component "button", { text: "Click here" }, cached: true, cache_key: @product.updated_at
+= component "button", { text: 'Click here' }, cached: true, cache_key: @product.updated_at
 ```
 
 ### Passing a block
@@ -158,8 +160,8 @@ The component also accepts a `block`. To render the block, just use the standard
 ```slim
 / app/views/pages/home.html.slim
 
-= component "button"
-  span= "My button"
+= component 'button'
+  span= 'My button'
 ```
 
 ```slim
@@ -180,7 +182,7 @@ Each component comes with a Ruby `module`. You can use it to set properties:
 
 module ButtonComponent
   property :href, required: true
-  property :text, default: "My button"
+  property :text, default: 'My button'
 end
 ```
 
@@ -200,10 +202,10 @@ If your partial becomes too complex and you want to extract logic from it, you m
 
 module ButtonComponent
   property :href, required: true
-  property :text, default: "My button"
+  property :text, default: 'My button'
 
   def external_link?
-    @href.starts_with? "http"
+    @href.starts_with? 'http'
   end
 end
 ```
@@ -213,7 +215,7 @@ end
 
 a.button(href=@href)
   = @text
-  = " (external link)" if external_link?
+  = ' (external link)' if external_link?
 ```
 
 ```slim
@@ -232,7 +234,7 @@ You can also choose to split your component into partials. In this case, we can
 a.button(href=@href)
   = @text
   - if external_link?
-    = render "suffix", text: "external link"
+    = render 'suffix', text: 'external link'
 ```
 
 ```slim
@@ -253,7 +255,7 @@ This will create the component in an `admin` folder, and name its Ruby module `A
 
 ### Stimulus integration
 
-Komponent supports [stimulus](https://github.com/stimulusjs/stimulus) 1.0.
+Komponent supports [Stimulus](https://github.com/stimulusjs/stimulus) >= 1.0.
 
 You can pass `--stimulus` to both generators to use Stimulus in your components.
 
@@ -261,7 +263,7 @@ You can pass `--stimulus` to both generators to use Stimulus in your components.
 rails generate komponent:install --stimulus
 ```
 
-This will yarn `stimulus` package, and create a `stimulus_application.js` in the `frontend` folder.
+This will `yarn add stimulus` and create a `stimulus_application.js` in the `frontend` folder.
 
 ```sh
 rails generate component button --stimulus
@@ -284,7 +286,7 @@ This will create a `yml` file for each locale (using `I18n.available_locales`).
 
 = a.button(href=@href)
   = @text
-  = render("suffix", text: t(".external_link")) if external_link?
+  = render('suffix', text: t(".external_link")) if external_link?
 ```
 
 ```yml
@@ -292,7 +294,7 @@ This will create a `yml` file for each locale (using `I18n.available_locales`).
 
 en:
   button_component:
-    external_link: "external link"
+    external_link: external link
 ```
 
 ```yml
@@ -300,7 +302,7 @@ en:
 
 fr:
   button_component:
-    external_link: "lien externe"
+    external_link: lien externe
 ```
 
 #### Available locales configuration
@@ -313,6 +315,34 @@ I18n.available_locales = [:en, :fr]
 > If you have the `rails-i18n` gem in your `Gemfile`, you should whitelist locales to prevent creating a lot of
 > locale files when you generate a new component.
 
+### Styleguide
+
+Komponent includes a basic styleguide engine that you can use in your project to document your components.
+
+![Komponent styleguide UI](https://user-images.githubusercontent.com/38524/41193700-45909330-6c10-11e8-87b7-59e628529200.png)
+
+To set it up, you can use the generator:
+
+```sh
+rails generate komponent:styleguide
+```
+
+This command will:
+
+* copy the styleguide components (`komponent/container`, `komponent/footer`, `komponent/header` and `komponent/sidebar`) to your components folder, so you can customize them
+* add a new `komponent.js` pack to your packs folder
+* mount the engine in your routes
+
+Then, for each component, you can describe it and render examples for each state in the `_example.html.slim` file from the component folder. The engine will then render it on the component page.
+
+If you have existing components, you can generate all their example files at once with:
+
+```sh
+rails generate komponent:examples
+```
+
+Finally, visit `http://localhost:3000/styleguide` to access your styleguide.
+
 ### Configuration
 
 #### Change default root path
@@ -320,7 +350,7 @@ I18n.available_locales = [:en, :fr]
 You can change the default root path (`frontend`) to another path where Komponent should be installed and components generated. You need to change `komponent.root` in an initializer.
 
 ```rb
-Rails.application.config.komponent.root = Rails.root.join("app/frontend")
+Rails.application.config.komponent.root = Rails.root.join('app/frontend')
 ```
 
 #### Default options for the generators
@@ -393,14 +423,14 @@ module MyEngine
       app.config.komponent.component_paths.append(MyEngine::Engine.root.join("frontend/components"))
     end
 
-    initializer "my_engine.action_dispatch" do |app|
+    initializer 'my_engine.action_dispatch' do |app|
       ActiveSupport.on_load :action_controller do
         ActionController::Base.prepend_view_path MyEngine::Engine.root.join("frontend")
       end
     end
 
     initializer 'my_engine.autoload', before: :set_autoload_paths do |app|
-      app.config.autoload_paths << MyEngine::Engine.root.join("frontend")
+      app.config.autoload_paths << MyEngine::Engine.root.join('frontend')
     end
   end
 end
@@ -425,10 +455,30 @@ resolved_paths:
   - engine/frontend
 ```
 
+## Running tests
+
+Run all Cucumber features and unit tests with `bundle exec appraisal rake test`
+
+Run the full test matrix with `bundle exec appraisal rake test`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/komposable/komponent.
 
+## Releasing a new version
+
+- Update the CHANGELOG (add a title and a date for the new version)
+- Update the version number in `lib/komponent/version`
+- Install the `gem-release` gem if you haven't already
+- Run `gem release --tag --push`
+- Create or update the release on Github with the same version number and copy-paste the description from the CHANGELOG
+
+Please note:
+
+If you're releasing a patch version (eg. from 2.0.1 to 2.0.2) you can run `gem bump patch --release --tag --push --sign` so you don't have to manually change the version number.
+
+If you want to release a specific version (eg. beta, RC...), you can run `gem bump 3.0.0.beta1 --release --tag --push --sign`
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/controllers/komponent/styleguide_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Komponent
+  class StyleguideController < ::ApplicationController
+    layout 'komponent'
+    rescue_from ActionView::MissingTemplate, with: :missing_template
+
+    def index; end
+
+    def show
+      @component = Komponent::Component.find(params[:id])
+    end
+
+    private
+
+    def missing_template
+      render 'komponent/styleguide/missing_template', status: :not_found
+    end
+  end
+end