css_modules 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21b9fabe952b1363c961b54679fc160c266a4015
-  data.tar.gz: 055009fe0234af3921b944ef78971844ca5f5076
+  metadata.gz: c35e16ca5e8afa7babee60ed35eee0bdc5348626
+  data.tar.gz: 3e028eab6b1ee508b100acc7f63e10896c865e26
 SHA512:
-  metadata.gz: d2bacefe1455169e48a20efe29caa16ed6ce85cc56f8dee9dd0535062f6245a19e3d2a66c558ce6a0988c0cf8153f840875e0400e7f434464d3b527ec67c53f7
-  data.tar.gz: 7bc30bd4c1c1a1c97b262aedd2f98616d89c4214fd4d63bc660c66e3fb91605b8f3ff1e6950319c4334bd7ed2ede9795c8121b6a29fc5fbd5d151f827ab7defd
+  metadata.gz: 1eb0f5526ea2707e4d0eeda968b45d8d06a48996476678c4fb81bbb71a8adfac7dfd86c4907b6f635775f1408adc3c538d2a13067dbf4de799dba1c31014fde9
+  data.tar.gz: 1d27222c3e2dfbc76d496ec97e7ced78cfb09a7efc212c6c7c31f4f3f4b9ef0c9ac4cb2b42409c3203ba4b13402e928993ab3fde72d3ccc710690cbda1bcfd2d

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/rmosolgo/css_modules.svg?branch=master)](https://travis-ci.org/rmosolgo/css_modules)
 [![Gem Version](https://badge.fury.io/rb/css_modules.svg)](https://badge.fury.io/rb/css_modules)
 
-An alternative to "magic string" classnames in Sass or SCSS. Currently supports Sprockets 2 only 😖.
+An alternative to "magic string" classnames in Sass or SCSS.
 
 Thanks to [Fatih Kadir Akın](https://twitter.com/fkadev) for his post, ["How I Implemented CSS Modules in Ruby on Rails, Easily"](https://medium.com/@fkadev/how-i-implemented-css-modules-to-ruby-on-rails-easily-abb324ce22d), which led the way on this idea!
 
@@ -158,8 +158,6 @@ $ gem install css_modules
   - Warn when not all styles are used?
   - Sprockets require CSS to JS? `require_styles` ?
 - Support plain `.css`
-- Support Sprockets 3+
-- Test on different Sass versions
 - Check for hash collisions in development
 - Fix sprockets cache: a new version of this gem should expire an old cache
 

data/lib/css_modules/version.rb

@@ -1,3 +1,3 @@
 module CSSModules
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/css_modules/view_helper.rb

@@ -7,9 +7,19 @@ module CSSModules
   #     helper CSSModules::ViewHelper
   #   end
   module ViewHelper
-    # @overload css_module(module_name, selector_name)
+    # @overload css_module(module_name)
     #   Apply the styles from `module_name` for `selector_name`
     #
+    #   @example Passing a module to a partial
+    #      style_module = css_module("events_index")
+    #      render(partial: "header", locals: { style_module: style_module })
+    #
+    #   @param module_name [String]
+    #   @return [StyleModule] helper for modulizing selectors within `module_name`
+    #
+    # @overload css_module(module_name, selector_names, bare_selector_names)
+    #   Apply the styles from `module_name` for `selector_names`
+    #
     #   @example Getting a selector within a module
     #      css_module("events_index", "header")
     #      # => "..." (opaque string which matches the stylesheet)
@@ -29,26 +39,30 @@ module CSSModules
     #     <% end %>
     #
     #   @param module_name [String]
-    #   @yieldparam [ModuleLookup] a helper for modulizing selectors within `module_name`
-    #   @return [void]
+    #   @yieldparam [StyleModule] a helper for modulizing selectors within `module_name`
+    #   @return [StyleModule] a helper for modulizing selectors within `module_name`
     def css_module(module_name, selector_names = nil, bare_selector_names = nil, &block)
-      lookup = ModuleLookup.new(module_name)
+      lookup = StyleModule.new(module_name)
 
       if selector_names.nil? && block_given?
         yield(lookup)
-        nil
+        lookup
       elsif selector_names.present?
         lookup.selector(selector_names.to_s, bare_selector_names.to_s)
       else
-        raise("css_module must be called with a module_name and either selector_names or a block")
+        lookup
       end
     end
 
-    class ModuleLookup
+    class StyleModule
       def initialize(module_name)
         @module_name = module_name
       end
 
+      def name
+        @module_name
+      end
+
       # @see {ViewHelper#css_module}
       # @param selector_names [String]
       # @param bare_selector_names [String]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: css_modules
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Robert Mosolgo