primer_view_components 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25626f31190d4622e822db5eb8f435f103c0a77668cb78c1db16eec60ac4dfb9
-  data.tar.gz: e551785879e69a0bd7c2ae62a97a39f311dc3dbc415bc5dade637d97fa297910
+  metadata.gz: ee845a3614e0d347957e7f16cf83750c9616bc63828d6ef9adaac62d6b5eb18d
+  data.tar.gz: 24d5d20ee47acdc6ed411c0ec609870fa7b8788d1debbdf15001a7851f7be54f
 SHA512:
-  metadata.gz: 6a77219748e0c7018f789df844cd6f6e83159b2fef82a5b81985c277d0427d85442e4e14c6f9934e387afc3f1d2291f31a3d88c9630c8f4910bae992d39a0188
-  data.tar.gz: 15b0b2a9faa1603f57d263a2a6b18f2eb4e1aa325d8c261bfce9f803571ae9a5075b1d51f8a5f3bf31bc7f12662dbe914f7380f71518fe6896b947f2d000757b
+  metadata.gz: ade2e2c9febaa32e5be37d60efe47c5ef8c7b17f41602e6f470bee8c21a499ab98ff52992aa484c4de3ab2f40f654f1ddc226fa1ac45077285e4349834dec542
+  data.tar.gz: 3d1eed4c85f4d513234f6ea9cdde584f83e54f7f2b6cf9197137b8e0ca6eeb6f15e2f51798b411d502452f910c5d1309ef0c1269b2b91559920048a2dfeb05f8

data/CHANGELOG.md

@@ -1,6 +1,14 @@
-# main
+# CHANGELOG
 
-# 0.0.8
+## main
+
+## 0.0.9
+
+* BREAKING CHANGE: OcticonComponent no longer accepts `class` parameter; use `classes` instead.
+
+    *heynan0*
+
+## 0.0.8
 
 * Add support for border margins, such as: `border_top: 0`.
 
@@ -10,19 +18,17 @@
 
     *Joel Hawksley*
 
-## Breaking changes
-
-* BlankslateComponent accepts `icon_size` instead of `icon_height`.
+* BREAKING CHANGE: BlankslateComponent accepts `icon_size` instead of `icon_height`.
 
     *Joel Hawksley*
 
-# 0.0.7
+## 0.0.7
 
 * Use `octicons_helper` v11.0.0.
 
     *Joel Hawksley*
 
-# 0.0.6
+## 0.0.6
 
 * Updated the invalid class name error message
 
@@ -40,21 +46,19 @@
 
     *Manuel Puyol*
 
-## Breaking changes
-
-* Changed `DetailsComponent` summary and body to be slots
+* BREAKING CHANGE: Changed `DetailsComponent` summary and body to be slots
 
     *Manuel Puyol*
 
-# 0.0.5
+## 0.0.5
 
 * Add support for box_shadow
 * Add components:
-    * Popover
+  * Popover
 
     *Sarah Vessels*
 
-# 0.0.4
+## 0.0.4
 
 * Added support for mx: and my: :auto.
 
@@ -63,19 +67,20 @@
 * Added support for custom layout sizes.
 
     *Manuel Puyol*
-# 0.0.3
+
+## 0.0.3
 
 * Add support for responsive `float` style argument.
 
     *Joel Hawksley*
 
 * Add components:
-    * Avatar
-    * Blankslate
+  * Avatar
+  * Blankslate
 
     *Manuel Puyol, Ben Emdon*
 
-# 0.0.1
+## 0.0.1
 
 * Add initial gem configuration.
 
@@ -90,24 +95,24 @@
     *Manuel Puyol*
 
 * Add components:
-    * BorderBox
-    * Box
-    * Breadcrumb
-    * Button
-    * Counter
-    * Details
-    * Dropdown
-    * Flex
-    * FlexItem
-    * Heading
-    * Label
-    * Layout
-    * Link
-    * ProgressBar
-    * State
-    * Subhead
-    * Text
-    * TimelineItem
-    * UnderlineNav
+  * BorderBox
+  * Box
+  * Breadcrumb
+  * Button
+  * Counter
+  * Details
+  * Dropdown
+  * Flex
+  * FlexItem
+  * Heading
+  * Label
+  * Layout
+  * Link
+  * ProgressBar
+  * State
+  * Subhead
+  * Text
+  * TimelineItem
+  * UnderlineNav
 
     *Manuel Puyol*

data/README.md

@@ -88,6 +88,7 @@ Some components have their own specific arguments, but they can all be styled wi
 | `box_shadow` | `box-shadow-<value>` | `box_shadow: :medium` → `.box-shadow-medium` |
 
 #### Boolean arguments
+
 | Component arguments | True    | False |
 | -------------- | ------- | ------ |
 | `underline`   | `underline: true` → `.text-underline`  | `underline: false` → `.no-underline` |
@@ -116,7 +117,7 @@ The same label using `Primer::HeadingComponent`:
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/primer/view_components. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/primer/view_components](https://github.com/primer/view_components). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ### Setting up
 
@@ -126,8 +127,7 @@ Run
 script/setup
 ```
 
-to install all necessary dependencies
-
+To install all necessary dependencies.
 
 ### Running tests
 
@@ -137,16 +137,20 @@ To run the full test suite:
 bundle exec rake
 ```
 
-### Storybook
+### Writing documentation
+
+Documentation is written as [YARD](https://yardoc.org/) comments directly in the source code, compiled into Markdown via `rake docs:build` and served by [Doctocat](https://github.com/primer/doctocat).
 
-*We recommend having [overmind](https://github.com/DarthSim/overmind) installed to run both rails and storybook, but it is not required.*
+### Storybook / Documentation
 
-To run storybook:
+To run Storybook and the documentation site, run:
 
 ```bash
-script/storybook
+script/dev
 ```
 
+_Note: Overmind is required to run script/dev._
+
 ### Developing with another app
 
 In your `Gemfile`, change:
@@ -171,6 +175,16 @@ you can check it in your app.
 
 Document components with [YARD](https://yardoc.org/). Docs are published to [RubyDoc.info](https://rubydoc.info/github/primer/view_components).
 
+## Deploying to Heroku
+
+We have both `staging` and `production` environments. To deploy Storybook to Heroku, run the following in `#primer-view-components-ops`:
+
+```bash
+.deploy primer-view-components</branch> to <environment>
+```
+
+If no `branch` is passed, `main` will be deployed.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/components/primer/blankslate_component.html.erb

@@ -3,7 +3,7 @@
     <%= render(Primer::OcticonComponent.new(
       icon: @icon,
       size: @icon_size,
-      class: "blankslate-icon"
+      classes: "blankslate-icon"
     )) %>
   <% end %>
 

data/app/components/primer/button_component.rb

@@ -34,19 +34,19 @@ module Primer
       **kwargs
     )
       @kwargs = kwargs
-      @kwargs[:tag] = fetch_or_fallback(TAG_OPTIONS, tag.to_sym, DEFAULT_TAG)
+      @kwargs[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)
 
       if @kwargs[:tag] == :a
         @kwargs[:role] = :button
       else
-        @kwargs[:type] = type.to_sym
+        @kwargs[:type] = type
       end
 
       @kwargs[:classes] = class_names(
         "btn",
         kwargs[:classes],
-        BUTTON_TYPE_MAPPINGS[fetch_or_fallback(BUTTON_TYPE_OPTIONS, button_type.to_sym, DEFAULT_BUTTON_TYPE)],
-        VARIANT_MAPPINGS[fetch_or_fallback(VARIANT_OPTIONS, variant.to_sym, DEFAULT_VARIANT)],
+        BUTTON_TYPE_MAPPINGS[fetch_or_fallback(BUTTON_TYPE_OPTIONS, button_type, DEFAULT_BUTTON_TYPE)],
+        VARIANT_MAPPINGS[fetch_or_fallback(VARIANT_OPTIONS, variant, DEFAULT_VARIANT)],
         "BtnGroup-item" => group_item
       )
     end

data/app/components/primer/counter_component.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
+  # Use Primer::CounterComponent to add a count to navigational elements and buttons.
   class CounterComponent < Primer::Component
     DEFAULT_SCHEME = :default
     SCHEME_MAPPINGS = {

data/app/components/primer/details_component.rb

@@ -24,7 +24,7 @@ module Primer
       @kwargs[:tag] = :details
       @kwargs[:classes] = class_names(
         kwargs[:classes],
-        OVERLAY_MAPPINGS[fetch_or_fallback(OVERLAY_MAPPINGS.keys, overlay.to_sym, OVERLAY_DEFAULT)],
+        OVERLAY_MAPPINGS[fetch_or_fallback(OVERLAY_MAPPINGS.keys, overlay, OVERLAY_DEFAULT)],
         "details-reset" => reset
       )
     end

data/app/components/primer/flash_component.rb

@@ -22,7 +22,7 @@ module Primer
       @kwargs[:classes] = class_names(
         @kwargs[:classes],
         "flash",
-        VARIANT_MAPPINGS[fetch_or_fallback(VARIANT_MAPPINGS.keys, variant.to_sym, DEFAULT_VARIANT)],
+        VARIANT_MAPPINGS[fetch_or_fallback(VARIANT_MAPPINGS.keys, variant, DEFAULT_VARIANT)],
         "flash-full": full
       )
       @kwargs[:mb] ||= spacious ? 4 : nil

data/app/components/primer/layout_component.rb

@@ -13,7 +13,7 @@ module Primer
 
     def initialize(responsive: false, side: DEFAULT_SIDE, sidebar_col: DEFAULT_SIDEBAR_COL, **kwargs)
       @kwargs = kwargs
-      @side = fetch_or_fallback(ALLOWED_SIDES, side.to_sym, DEFAULT_SIDE)
+      @side = fetch_or_fallback(ALLOWED_SIDES, side, DEFAULT_SIDE)
       @responsive = responsive
       @kwargs[:classes] = class_names(
         "gutter-condensed gutter-lg",

data/app/components/primer/octicon_component.rb

@@ -16,8 +16,13 @@ module Primer
     def initialize(icon:, size: SIZE_DEFAULT, **kwargs)
       @icon, @kwargs = icon, kwargs
 
-      @kwargs[:height] = SIZE_MAPPINGS[size.to_sym]
-      @kwargs[:class] = class_names(@kwargs[:class], Primer::Classify.call(**@kwargs)[:class])
+      @kwargs[:class] = Primer::Classify.call(**@kwargs)[:class]
+      @kwargs[:height] ||= SIZE_MAPPINGS[size]
+
+      # Filter out classify options to prevent them from becoming invalid html attributes.
+      # Note height and width are both classify options and valid html attributes.
+      octicon_helper_options = @kwargs.slice(:height, :width)
+      @kwargs = @kwargs.except(*Primer::Classify::VALID_KEYS, :classes).merge(octicon_helper_options)
     end
 
     def call

data/lib/primer/view_components/version.rb

@@ -5,7 +5,7 @@ module Primer
     module VERSION
       MAJOR = 0
       MINOR = 0
-      PATCH = 8
+      PATCH = 9
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -70,6 +70,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +182,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
-description:
+description: 
 email:
 - opensource+primer_view_components@github.com
 executables: []
@@ -229,7 +243,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -245,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: ViewComponents for the Primer Design System
 test_files: []