develop_with_style 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57f412a7a128ae543858d946f0cf7cbbcd785f6f4cd8d3e6ce215be7bcffc004
+  data.tar.gz: 64045153ee771be411cd34e4b2093bfe67ac728a79bf780a04dc80cb2b721dc1
+SHA512:
+  metadata.gz: d22c0a0d1361ce61e8aafe8988ef23a821219a222e3fa8e926fbe2bf8c4a9c36e31e0df83250e8de64eb95dc7e914ebc697ac9c7e7b5debbe0e77f8cca30ff59
+  data.tar.gz: 3ad42fe472ebf92bc055e6bc3692efdb505a2ca619362eca69312ff6afeef89df1abf8dd379f016c062fc8de073b4e939055700573436fa80d721ee5ac7a8c04

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joel@developwithstyle.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in develop_with_style.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    develop_with_style (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  develop_with_style!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Joel Moss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Develop With Style
+
+Enjoy writing CSS in your Rails application and Develop With Style!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'develop_with_style'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install develop_with_style
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joelmoss/develop_with_style. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DevelopWithStyle project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joelmoss/develop_with_style/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "develop_with_style"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/develop_with_style.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "develop_with_style/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "develop_with_style"
+  spec.version       = DevelopWithStyle::VERSION
+  spec.authors       = ["Joel Moss"]
+  spec.email         = ["joel@developwithstyle.com"]
+
+  spec.summary       = %q{Enjoy writing CSS in your Rails application and Develop With Style!}
+  spec.description   = %q{Create global and local CSS with very little effort.}
+  spec.homepage      = "https://github.com/joelmoss/develop_with_style"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/develop_with_style.rb

@@ -0,0 +1,7 @@
+require "develop_with_style/version"
+
+module DevelopWithStyle
+  # Nothing to see here, move along
+end
+
+require "develop_with_style/railtie"

data/lib/develop_with_style/helper.rb

@@ -0,0 +1,18 @@
+module DevelopWithStyle::Helper
+  def style(name, tag_name: :div, &block)
+    @css_modules ||= []
+    @css_modules << @virtual_path unless @css_modules.include?(@virtual_path)
+
+    path = "app/javascript/packs/#{@virtual_path}.module.scss"
+    class_name = Base64.encode64(path).gsub(/\W/, '')[0, 8] + "__#{name}"
+
+    block_given? ? tag.send(tag_name, class: class_name, &block) : class_name
+  end
+
+  def developed_with_style
+    asset = "#{@virtual_path}#{compute_asset_extname(@virtual_path, type: :stylesheet)}"
+    Webpacker.manifest.lookup(asset) && @css_modules.unshift(@virtual_path)
+
+    stylesheet_pack_tag(*@css_modules)
+  end
+end

data/lib/develop_with_style/railtie.rb

@@ -0,0 +1,15 @@
+require "rails/railtie"
+
+require "develop_with_style/helper"
+
+class DevelopWithStyle::Engine < ::Rails::Engine
+  initializer "webpacker.helper" do
+    ActiveSupport.on_load :action_controller do
+      ActionController::Base.helper DevelopWithStyle::Helper
+    end
+
+    ActiveSupport.on_load :action_view do
+      include DevelopWithStyle::Helper
+    end
+  end
+end

data/lib/develop_with_style/version.rb

@@ -0,0 +1,3 @@
+module DevelopWithStyle
+  VERSION = "0.1.0"
+end

data/lib/install/examples/home.module.scss

@@ -0,0 +1,3 @@
+.base {
+  background-color: orange;
+}

data/lib/install/examples/layout.css

@@ -0,0 +1,3 @@
+body {
+  background-color: green;
+}

data/lib/install/template.rb

@@ -0,0 +1,18 @@
+say 'Copying loader to config/webpack/loaders'
+copy_file "#{__dir__}/webpacker_loader.js", Rails.root.join('config/webpack/loaders/develop_with_style.js').to_s
+
+say 'Adding loader plugin to config/webpack/environment.js'
+insert_into_file Rails.root.join('config/webpack/environment.js').to_s,
+  "require('./loaders/develop_with_style')\n",
+  after: "require('@rails/webpacker')\n"
+
+say "Copying example entry file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/examples/layout.css", "#{Webpacker.config.source_entry_path}/layouts/application.css"
+copy_file "#{__dir__}/examples/home.module.scss", "#{Webpacker.config.source_entry_path}/pages/home.module.scss"
+
+say 'Adding #developed_with_style helper to app/views/layouts/application.html.erb'
+insert_into_file Rails.root.join('app/views/layouts/application.html.erb').to_s,
+  "<%= developed_with_style %>\n",
+  before: "</head>\n"
+
+say "You're now Developing with Style 🎉", :green

data/lib/install/webpacker_loader.js

@@ -0,0 +1,31 @@
+// This modifies the CSS modules loader to use a different ident that allows us to pick it out via
+// the #style Rails helper.
+
+const { environment } = require('@rails/webpacker')
+const path = require('path')
+
+let sassLoader = environment.loaders.get('moduleSass');
+const index = sassLoader.use.findIndex(el => el.loader === 'css-loader');
+
+function getLocalIdent(loaderContext, localIdentName, localName, options) {
+  if(!options.context) {
+    if (loaderContext.rootContext) {
+      options.context = loaderContext.rootContext;
+    } else if (loaderContext.options && typeof loaderContext.options.context === "string") {
+      options.context = loaderContext.options.context;
+    } else {
+      options.context = loaderContext.context;
+    }
+  }
+
+  var request = path.relative(options.context, loaderContext.resourcePath)
+  request = Buffer.from(request).toString('base64').replace(/\W/, '')
+
+  return request.substr(0, 8) + '__' + localName
+}
+
+sassLoader.use[index].options = {
+  modules: true,
+  sourceMap: true,
+  getLocalIdent
+}

data/lib/tasks/develop_with_style.rake

@@ -0,0 +1,12 @@
+install_template_path = File.expand_path("../install/template.rb", __dir__).freeze
+
+desc 'Install and begin Developing with Style.'
+task :develop_with_style do
+  puts 'Developing with Style...'
+
+  if Rails::VERSION::MAJOR >= 5
+    exec "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{install_template_path}"
+  else
+    exec "#{RbConfig.ruby} ./bin/rake rails:template LOCATION=#{install_template_path}"
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: develop_with_style
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Moss
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Create global and local CSS with very little effort.
+email:
+- joel@developwithstyle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- develop_with_style.gemspec
+- lib/develop_with_style.rb
+- lib/develop_with_style/helper.rb
+- lib/develop_with_style/railtie.rb
+- lib/develop_with_style/version.rb
+- lib/install/examples/home.module.scss
+- lib/install/examples/layout.css
+- lib/install/template.rb
+- lib/install/webpacker_loader.js
+- lib/tasks/develop_with_style.rake
+homepage: https://github.com/joelmoss/develop_with_style
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Enjoy writing CSS in your Rails application and Develop With Style!
+test_files: []