backpack 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f455dfc7418df004f73f4697c896dfb7d618c34fee245dcfc7caa12dd58904a8
-  data.tar.gz: a502296b352348649b37b8f051ca10e12acf98cf7b441a8aff5bb30938829cef
+  metadata.gz: 44c0421edb61a91faa198193efbcffd57558eaf057464f1ced1311d2488634d8
+  data.tar.gz: 7fa25d424958ab6b2c746e675160736dd5bdac34f96b325019377d2022669f1b
 SHA512:
-  metadata.gz: bd011f10cddd10eaa9592298c9dcaf3fd95e03fc23cfe9503dd77df228d8d62e0b4d11d9c9fcac1945567bf328bf7c2b91166d2455393c5f2d22e778046b22de
-  data.tar.gz: cac2f06b3bdb086165d4a9e9701d8e5a1c9aeea7d60f9432cac3831a6b5aff1f3146dfd3590ad17826e7d9cc36ec132bd41584bd6e3a8c5d7e434159bc184cd0
+  metadata.gz: 03e451b6c6fee7247f0723de93e2065d2ff1a690a12bf7576285e872c038ff6c38fd3f641aa2c92c040a45d4afacd523c7ef31ad194f63c45dcbe3a2adebd5ba
+  data.tar.gz: 6e741f04048aec8d997c4edfe10592e42664c97ceb9d00ac4c409453f10ff04b42cdd218b5ce055dbd359c53878171bf695229d34c625a9379086ec0c3f08571

data/.gitlab-ci.yml

@@ -53,8 +53,8 @@ tests:
   variables:
     COVERAGE: "true"
     DISABLE_SPRING: 1
-  before_script:
-    - yarn
+  # before_script:
+  #   - yarn
   script:
     - bundle exec rspec --format progress --format RspecJunitFormatter --out rspec.xml
   coverage: /\(\d+.\d+\%\) covered/

data/README.md

@@ -3,7 +3,9 @@
 ## Getting started
 
 ```bash
-bundle add backpack
+gem install backpack
+backpack import
+gem uninstall backpack
 ```
 
 ## Usage
@@ -24,6 +26,14 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Running the CLI
+
+You can run the command line in development:
+
+```bash
+bundle exec bin/backpack
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/etaminstudio/backpack.

data/demo/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: ..
   specs:
-    backpack (0.4.1)
+    backpack (0.4.2)
       literal (~> 1.8)
       phlex-rails (~> 2.3)
       rails
       rails-html-sanitizer
+      thor
 
 GEM
   remote: https://rubygems.org/

data/lib/backpack/cli.rb

@@ -0,0 +1,39 @@
+require "thor"
+require "backpack"
+
+module Backpack
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "import", "Import Backpack in the current project"
+
+    source_root File.expand_path(__dir__)
+
+    def import
+      say ascii_art, :green
+
+      directory "stylesheets", "app/assets/stylesheets", recursive: true
+      directory "components", "app/components", recursive: true
+
+      copy_file "attributes.rb", "lib/backpack/attributes.rb"
+      copy_file "classes.rb", "lib/backpack/classes.rb"
+      copy_file "identifier.rb", "lib/backpack/identifier.rb"
+      copy_file "tokens.rb", "lib/backpack/tokens.rb"
+
+      directory "../../spec/components", "spec/components", recursive: true do |content|
+        content.gsub("require 'spec_helper'", "require 'rails_helper'")
+      end
+    end
+
+    private
+
+    def ascii_art
+      <<~ASCII
+      ┌┐ ┌─┐┌─┐┬┌─┌─┐┌─┐┌─┐┬┌─
+      ├┴┐├─┤│  ├┴┐├─┘├─┤│  ├┴┐
+      └─┘┴ ┴└─┘┴ ┴┴  ┴ ┴└─┘┴ ┴
+
+      ASCII
+    end
+  end
+end

data/lib/backpack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Backpack
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/lib/backpack.rb

@@ -7,6 +7,8 @@ require 'literal'
 require 'phlex-rails'
 require 'rails'
 
+require 'backpack/cli'
+
 require 'backpack/attributes'
 require 'backpack/classes'
 require 'backpack/identifier'

data/spec/cli/import_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Backpack::CLI, type: :cli do
+  sandbox_dir = "sandbox"
+
+  around do |example|
+    FileUtils.mkdir(sandbox_dir) unless File.exist?(sandbox_dir)
+    within_dir(sandbox_dir) do
+      example.run
+    end
+  ensure
+    FileUtils.rm_rf(sandbox_dir)
+  end
+
+  describe "import" do
+    let(:command) { `ruby ../bin/backpack import` }
+    let(:output) { command.chomp }
+
+    it "outputs ascii art and the list of created files" do
+      expect(output).to include(described_class.new.send(:ascii_art))
+      expect(output).to include("create  app/assets/stylesheets/application.css")
+      expect(output).to include("create  app/components/base.rb")
+      expect(output).to include("create  app/components/button.rb")
+      expect(output).to include("create  app/components/button/button.js")
+      expect(output).to include("create  app/components/button/button.css")
+      expect(output).to include("create  lib/backpack/attributes.rb")
+      expect(output).to include("create  lib/backpack/classes.rb")
+      expect(output).to include("create  lib/backpack/identifier.rb")
+      expect(output).to include("create  lib/backpack/tokens.rb")
+      expect(output).to include("create  spec/components/button_spec.rb")
+      expect(output).to include("create  spec/components/previews/button_preview.rb")
+      expect(output).to include("create  spec/components/previews/button_preview/overview.html.erb")
+    end
+
+    it "copies the folders" do
+      command
+      expect(File.directory?("app/assets/stylesheets")).to be true
+      expect(File.directory?("app/components")).to be true
+      expect(File.directory?("spec/components")).to be true
+      expect(File.directory?("spec/components/previews")).to be true
+    end
+
+    it "copies the lib files" do
+      command
+      expect(File.exist?("lib/backpack/attributes.rb")).to be true
+      expect(File.exist?("lib/backpack/classes.rb")).to be true
+      expect(File.exist?("lib/backpack/identifier.rb")).to be true
+      expect(File.exist?("lib/backpack/tokens.rb")).to be true
+    end
+  end
+end

data/spec/components/badge_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe Components::Badge, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) { text } }
   let(:params) { {} }
   let(:text) { "Badge" }
 
-  subject(:output) { render_fragment(component) }
-
   it "renders the element with the default styling" do
     expect(output).to have_css(
       ".Badge.Badge-variant-solid", text:

data/spec/components/breadcrumb_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 describe Components::Breadcrumb, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) }
   let(:params) { {} }
 
-  subject(:output) { render_fragment(component) }
-
   context "without items" do
     it "renders nothing" do
       expect(output).to eq_html('')
@@ -25,9 +25,15 @@ describe Components::Breadcrumb, type: :component do
       expect(output).to have_css("nav.Breadcrumb[role='navigation'][aria-label='Breadcrumb']")
     end
 
-    it "renders all items" do
+    it "renders first item" do
       expect(output).to have_css("li:nth-child(1) a[href='/']", text: "Home")
+    end
+
+    it "renders second item" do
       expect(output).to have_css("li:nth-child(2) a[href='/sections']", text: "Sections")
+    end
+
+    it "renders third item" do
       expect(output).to have_css("li:nth-child(3) a[href='']", text: "Articles")
     end
 

data/spec/components/button_spec.rb

@@ -1,20 +1,20 @@
 require 'spec_helper'
 
 describe Components::Button, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) { text } }
   let(:params) { {} }
   let(:text) { "Label" }
 
-  subject(:output) { render_fragment(component) }
-
   it "renders a button element with the default styling" do
     expect(output).to have_css(
       "button.Button.Button-variant-solid.Button-size-2", text:
     )
   end
 
-  it "doesn't render an icon" do
-    expect(output).to_not have_css("button.Button svg.Icon")
+  it "doesn't render the icon" do
+    expect(output).not_to have_css("button.Button svg.Icon")
   end
 
   context "with a href" do

data/spec/components/favicon_spec.rb

@@ -1,11 +1,12 @@
 require 'spec_helper'
 
 describe Components::Favicon, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) }
   let(:params) { {} }
 
-  subject(:output) { render_fragment(component) }
-
+  # rubocop:disable RSpec/ExampleLength
   it "renders the links" do
     expect(output).to eq_html <<~HTML
       <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
@@ -15,6 +16,7 @@ describe Components::Favicon, type: :component do
       <link rel="manifest" href="/site.webmanifest">
     HTML
   end
+  # rubocop:enable RSpec/ExampleLength
 
   context "with application name" do
     let(:params) { { application_name: "My App" } }

data/spec/components/heading_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe Components::Heading, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) { text } }
   let(:params) { {} }
   let(:text) { "Heading" }
 
-  subject(:output) { render_fragment(component) }
-
   it "renders a level 1 heading by default" do
     expect(output).to have_css("h1.Heading.Heading-1", text:)
   end

data/spec/components/icon_button_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 describe Components::IconButton, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) }
   let(:params) { { icon: :user, label: "User" } }
 
-  subject(:output) { render_fragment(component) }
-
   it "renders a button element with the default styling" do
     expect(output).to have_css(
       "button.IconButton.IconButton-variant-solid.IconButton-size-2"

data/spec/components/icon_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe Components::Icon, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(key, **params) }
   let(:key) { nil }
   let(:params) { {} }
 
-  subject(:output) { render_fragment(component) }
-
   context "with symbol key" do
     let(:key) { :user }
 

data/spec/components/icon_sprite_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 describe Components::IconSprite, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) }
   let(:params) { {} }
 
-  subject(:output) { render_fragment(component) }
-
   context "without Current" do
     it "renders nothing" do
       expect(output).to eq_html('')

data/spec/components/previews/badge_preview/overview.html.erb

@@ -1,13 +1,12 @@
-<% props = Components::Badge.literal_properties %>
-
+<%
+props = Components::Badge.literal_properties
+%>
 <table class="lookbook-table">
   <thead>
     <tr>
       <th>Color</th>
       <% props[:color].type.each do |color| %>
-        <th colspan="<%= props[:size].type.to_a.size %>">
-          <code><%= color || :default %></code>
-        </th>
+        <th colspan="<%= props[:size].type.to_a.size %>"><code><%= color || :default %></code></th>
       <% end %>
     </tr>
     <tr>
@@ -25,9 +24,7 @@
         <th><code><%= variant %></code></th>
         <% props[:color].type.each do |color| %>
           <% props[:size].type.each do |size| %>
-            <td>
-              <%= render Components::Badge.new(variant:, size:, color:) { "Badge" } %>
-            </td>
+            <td><%= render Components::Badge.new(variant:, size:, color:) { "Badge" } %></td>
           <% end %>
         <% end %>
       </tr>

data/spec/components/previews/button_preview/overview.html.erb

@@ -1,14 +1,13 @@
-<% props = Components::Button.literal_properties
-icon = "arrow-right" %>
-
+<%
+props = Components::Button.literal_properties
+icon = "arrow-right"
+%>
 <table class="lookbook-table">
   <thead>
     <tr>
       <th>Color</th>
       <% props[:color].type.each do |color| %>
-        <th colspan="<%= props[:size].type.to_a.size %>">
-          <code><%= color || :default %></code>
-        </th>
+        <th colspan="<%= props[:size].type.to_a.size %>"><code><%= color || :default %></code></th>
       <% end %>
     </tr>
     <tr>
@@ -26,9 +25,7 @@ icon = "arrow-right" %>
         <th><code><%= variant %></code></th>
         <% props[:color].type.each do |color| %>
           <% props[:size].type.each do |size| %>
-            <td>
-              <%= render Components::Button.new(variant:, size:, color:, icon:) { "Button" } %>
-            </td>
+            <td><%= render Components::Button.new(variant:, size:, color:, icon:) { "Button" } %></td>
           <% end %>
         <% end %>
       </tr>
@@ -36,9 +33,7 @@ icon = "arrow-right" %>
         <th><code><%= variant %></code>, <code>disabled</code></th>
         <% props[:color].type.each do |color| %>
           <% props[:size].type.each do |size| %>
-            <td>
-              <%= render Components::Button.new(variant:, size:, color:, icon:, disabled: true) { "Button" } %>
-            </td>
+            <td><%= render Components::Button.new(variant:, size:, color:, icon:, disabled: true) { "Button" } %></td>
           <% end %>
         <% end %>
       </tr>

data/spec/components/previews/quotation_preview/overview.html.erb

@@ -1,5 +1,6 @@
-<% props = Components::Quotation.literal_properties %>
-
+<%
+props = Components::Quotation.literal_properties
+%>
 <table class="lookbook-table">
   <thead>
     <tr>
@@ -14,9 +15,7 @@
       <tr>
         <th><code><%= size %></code></th>
         <% props[:weight].type.each do |weight| %>
-          <td>
-            <%= render Components::Quotation.new(size:, weight:, cite: "Jan Tschichold") { "Perfect typography is certainly the most elusive of all arts. Sculpture in stone alone comes near it in obstinacy." } %>
-          </td>
+          <td><%= render Components::Quotation.new(size:, weight:, cite: "Jan Tschichold") { "Perfect typography is certainly the most elusive of all arts. Sculpture in stone alone comes near it in obstinacy." } %></td>
         <% end %>
       </tr>
     <% end %>

data/spec/components/previews/rich_text_preview.rb

@@ -2,6 +2,7 @@ class RichTextPreview < Lookbook::Preview
   include Components
 
   # Content comes from [Chris Coyer's HTML Kitchen-sink](https://codepen.io/chriscoyier/pen/JpLzjd)
+  # rubocop:disable Rails/OutputSafety
   def default
     RichText() do
       <<~HTML.html_safe
@@ -98,4 +99,5 @@ class RichTextPreview < Lookbook::Preview
       HTML
     end
   end
+  # rubocop:enable Rails/OutputSafety
 end

data/spec/components/quotation_spec.rb

@@ -1,17 +1,19 @@
 require 'spec_helper'
 
 describe Components::Quotation, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) { html } }
   let(:params) { {} }
   let(:text) do
     "Perfect typography is certainly the most elusive of all arts. Sculpture in stone alone comes near it in obstinacy."
   end
   let(:html) do
+    # rubocop:disable Rails/OutputSafety
     "<p>#{text}</p>".html_safe
+    # rubocop:enable Rails/OutputSafety
   end
 
-  subject(:output) { render_fragment(component) }
-
   it "renders a blockquote element" do
     expect(output).to have_css("blockquote.Quotation.Quotation-size-2",
                                text:)
@@ -22,8 +24,8 @@ describe Components::Quotation, type: :component do
   end
 
   it "doesn't render a footer not a cite element" do
-    expect(output).to_not have_css("blockquote.Quotation footer")
-    expect(output).to_not have_css("blockquote.Quotation cite")
+    expect(output).not_to have_css("blockquote.Quotation footer")
+    expect(output).not_to have_css("blockquote.Quotation cite")
   end
 
   context "with a cite" do

data/spec/components/rich_text_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe Components::RichText, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) { html } }
   let(:params) { {} }
   let(:html) { "<h1>Hello</h2> <p>World</p>".html_safe }
 
-  subject(:output) { render_fragment(component) }
-
   it "wraps content in a div with the default class" do
     expect(output).to have_css("div.RichText", text: "Hello World")
   end

data/spec/components/skip_links_spec.rb

@@ -1,18 +1,23 @@
 require 'spec_helper'
 
-describe Components::SkipLinks, type: :component do
+RSpec.describe Components::SkipLinks, type: :component do
+  subject(:output) { render_fragment(component) }
+
   let(:component) { described_class.new(**params) }
   let(:params) { {} }
 
-  subject(:output) { render_fragment(component) }
-
-  it "renders the skip links list" do
-    expect(output).to have_css("ul.SkipLinks")
+  it "renders 2 items" do
     expect(output).to have_css("ul.SkipLinks > li", count: 2)
+  end
+
+  it "renders the first link" do
     expect(output).to have_css(
       "ul.SkipLinks > li:nth-child(1) > a[href='#content']",
       text: "Aller au contenu"
     )
+  end
+
+  it "renders the second link" do
     expect(output).to have_css(
       "ul.SkipLinks > li:nth-child(2) > a[href='#navigation']",
       text: "Aller à la navigation"

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 
+  config.include CLIHelpers, type: :cli
   config.include ComponentSpecHelpers, type: :component
   config.include Capybara::RSpecMatchers, type: :component
   config.include RSpecHtmlMatchers, type: :component

data/spec/support/cli_helpers.rb

@@ -0,0 +1,5 @@
+module CLIHelpers
+  def within_dir(target, &block)
+    ::Dir.chdir(target, &block)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backpack
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Lucas Heymès
@@ -67,6 +67,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
 email:
 - team@etamin.studio
 executables: []
@@ -573,6 +601,7 @@ files:
 - lib/backpack.rb
 - lib/backpack/attributes.rb
 - lib/backpack/classes.rb
+- lib/backpack/cli.rb
 - lib/backpack/components.rb
 - lib/backpack/components/badge.rb
 - lib/backpack/components/badge/badge.css
@@ -617,6 +646,7 @@ files:
 - lib/backpack/stylesheets/utilities/_sr-only.css
 - lib/backpack/tokens.rb
 - lib/backpack/version.rb
+- spec/cli/import_spec.rb
 - spec/components/badge_spec.rb
 - spec/components/breadcrumb_spec.rb
 - spec/components/button_spec.rb
@@ -645,6 +675,7 @@ files:
 - spec/fixtures/icons/close.svg
 - spec/fixtures/icons/user.svg
 - spec/spec_helper.rb
+- spec/support/cli_helpers.rb
 - spec/support/components.rb
 - spec/support/matchers/eq_html.rb
 - spec/support/matchers/include_html.rb
@@ -671,4 +702,38 @@ requirements: []
 rubygems_version: 3.7.2
 specification_version: 4
 summary: When you go on a trek, don't forget your backpack.
-test_files: []
+test_files:
+- spec/cli/import_spec.rb
+- spec/components/badge_spec.rb
+- spec/components/breadcrumb_spec.rb
+- spec/components/button_spec.rb
+- spec/components/favicon_spec.rb
+- spec/components/heading_spec.rb
+- spec/components/icon_button_spec.rb
+- spec/components/icon_spec.rb
+- spec/components/icon_sprite_spec.rb
+- spec/components/previews/badge_preview.rb
+- spec/components/previews/badge_preview/overview.html.erb
+- spec/components/previews/breadcrumb_preview.rb
+- spec/components/previews/button_preview.rb
+- spec/components/previews/button_preview/overview.html.erb
+- spec/components/previews/heading_preview.rb
+- spec/components/previews/icon_button_preview.rb
+- spec/components/previews/icon_button_preview/overview.html.erb
+- spec/components/previews/icon_preview.rb
+- spec/components/previews/quotation_preview.rb
+- spec/components/previews/quotation_preview/overview.html.erb
+- spec/components/previews/rich_text_preview.rb
+- spec/components/previews/skip_links_preview.rb
+- spec/components/quotation_spec.rb
+- spec/components/rich_text_spec.rb
+- spec/components/skip_links_spec.rb
+- spec/fixtures/icons/arrow-right.svg
+- spec/fixtures/icons/close.svg
+- spec/fixtures/icons/user.svg
+- spec/spec_helper.rb
+- spec/support/cli_helpers.rb
+- spec/support/components.rb
+- spec/support/matchers/eq_html.rb
+- spec/support/matchers/include_html.rb
+- spec/support/spec_helpers.rb