componentize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07f13b0a8419f2b8b8d410543721092ac6bb83fb
+  data.tar.gz: 871e45a645e2e4e69f4cfc2b536e0d1b48ebce8f
+SHA512:
+  metadata.gz: d88eef098d5b091bf07628aa245f3a0786e68b0f5d405241efdc4bb5f6c7ec1836de55df33d747f33efca5c3ac8a55fc6912f7004c80bfa27c9294482901a784
+  data.tar.gz: 9b59116198d980fb673d1db4ad1866d1a174491c73986055a967de470e8cba3559e3b897dcd4eb5780eb19be7e679b311f6c166ae7eddb64aaf17cbf7e992a5d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in componentize.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kyle Shevlin
+
+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,73 @@
+# Componentize
+
+Rails generator for inline and block level "components". Generates a view file, SCSS partial, and adds the right `@import` to the `base.scss` file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'componentize'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install componentize
+```
+
+## Usage
+
+```
+rails generate component <NAME> [options]
+```
+
+## Options
+
+| Option | Type | Description | Default Value |
+|---|---|---|---|
+| --format | String | File extension format. Can be `erb`, `slim`, or `haml` | `erb` |
+| --block | Boolean | Whether component is inline or block level | `false` |
+
+## Full Example
+
+```
+rails generate component my-block-component --format slim --block
+```
+
+## Including Components in Views
+
+Inline component:
+
+```erb
+<%= render 'my_component', foo: 'bar' %>
+```
+
+Block component:
+
+```erb
+<%= render layout: 'my_section', locals: { foo: 'bar' } do %>
+  <%# Content goes here and is rendered in the block's yield %>
+<% end %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/kyleshevlin/componentize.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "componentize"
+
+# 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

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/componentize.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'componentize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "componentize"
+  spec.version       = Componentize::VERSION
+  spec.authors       = ["Kyle Shevlin"]
+  spec.email         = ["kyle.a.shevlin@gmail.com"]
+  spec.summary       = %q{Generator for inline and block level Rails components. Similar to Ember's component generator.}
+  spec.description   = %q{Generator for inline and block level Rails components. Similar to Ember's component generator.}
+  spec.homepage      = "https://github.com/kyleshevlin/componentize"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails", ">= 3.1"
+end

data/lib/componentize.rb

@@ -0,0 +1,5 @@
+require "componentize/engine"
+require "componentize/version"
+
+module Componentize
+end

data/lib/componentize/engine.rb

@@ -0,0 +1,4 @@
+module Componentize
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/componentize/version.rb

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

data/lib/generators/component/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Generates a Slim and SCSS file for your component and adds the file import to base.scss
+
+Example:
+    rails generate component my-component
+
+    This will create:
+        app/assets/stylesheets/blocks/_my_component.scss
+        app/views/application/_my_component.html.erb
+
+    And this will add the following to base.scss:
+        @import 'blocks/my_component';
+
+Options
+    --block, Boolean, default: false; Will designate this component as a block component and add
+        a yield to the view file.
+
+    --format, String, default: 'erb'; Will set the extension format for the view file. Acceptable
+        options are: 'erb', 'slim', and 'haml'

data/lib/generators/component/component_generator.rb

@@ -0,0 +1,52 @@
+require 'rails/generators/named_base'
+require 'fileutils'
+
+class ComponentGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  class_option :format, type: :string, default: 'erb'
+  class_option :block, type: :boolean, default: false
+
+  def set_component_name_variable
+    @component_name = component_name
+  end
+
+  def set_extension
+    @extension = validate_extension_format(options[:format])
+  end
+
+  def create_component_files
+    create_view_file
+    create_sass_file
+    update_base_imports_file
+  end
+
+  private
+
+  def component_name
+    file_name.gsub(/-/, '_')
+  end
+
+  def validate_extension_format(format)
+    whitelist = ['erb', 'slim', 'haml']
+    return whitelist.include?(format) ? format : 'erb'
+  end
+
+  def create_view_file
+    created_file_name = "app/views/application/_#{component_name}.html.#{@extension}"
+    template_type = options[:block] ? 'block_template' : 'inline_template'
+
+    template "#{@extension}/#{template_type}.html.#{@extension}", created_file_name
+  end
+
+  def create_sass_file
+    style_dir = options[:block] ? 'sections' : 'blocks'
+    template 'component_stylesheet_template.scss', "app/assets/stylesheets/#{style_dir}/_#{component_name}.scss"
+  end
+
+  def update_base_imports_file
+    FileUtils.touch('app/assets/stylesheets/base.scss')
+    style_dir = options[:block] ? 'sections' : 'blocks'
+    append_to_file 'app/assets/stylesheets/base.scss', "@import '#{style_dir}/#{component_name}';\n"
+  end
+end

data/lib/generators/component/templates/component_stylesheet_template.scss

@@ -0,0 +1,7 @@
+//////////////////////////////
+// <%= @component_name %>
+//////////////////////////////
+
+.<%= @component_name %> {
+
+}

data/lib/generators/component/templates/erb/block_template.html.erb

@@ -0,0 +1,8 @@
+<%%
+  # Ruby code goes here
+%>
+
+<div class="<%= @component_name %>">
+  <!-- Markup goes here -->
+  <%%= yield %>
+</div>

data/lib/generators/component/templates/erb/inline_template.html.erb

@@ -0,0 +1,7 @@
+<%%
+  # Ruby code goes here
+%>
+
+<div class="<%= @component_name %>">
+  <!-- Markup goes here -->
+</div>

data/lib/generators/component/templates/haml/block_template.html.haml

@@ -0,0 +1,5 @@
+- # Ruby code goes here
+
+.<%= @component_name %>
+  / Markup goes here
+  = yield

data/lib/generators/component/templates/haml/inline_template.html.haml

@@ -0,0 +1,4 @@
+- # Ruby code goes here
+
+.<%= @component_name %>
+  / Markup goes here

data/lib/generators/component/templates/slim/block_template.html.slim

@@ -0,0 +1,6 @@
+ruby:
+  # Ruby code goes here
+
+.<%= @component_name %>
+  / Markup goes here
+  == yield

data/lib/generators/component/templates/slim/inline_template.html.slim

@@ -0,0 +1,5 @@
+ruby:
+  # Ruby code goes here
+
+.<%= @component_name %>
+  / Markup goes here

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: componentize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Shevlin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Generator for inline and block level Rails components. Similar to Ember's
+  component generator.
+email:
+- kyle.a.shevlin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- componentize.gemspec
+- lib/componentize.rb
+- lib/componentize/engine.rb
+- lib/componentize/version.rb
+- lib/generators/component/USAGE
+- lib/generators/component/component_generator.rb
+- lib/generators/component/templates/component_stylesheet_template.scss
+- lib/generators/component/templates/erb/block_template.html.erb
+- lib/generators/component/templates/erb/inline_template.html.erb
+- lib/generators/component/templates/haml/block_template.html.haml
+- lib/generators/component/templates/haml/inline_template.html.haml
+- lib/generators/component/templates/slim/block_template.html.slim
+- lib/generators/component/templates/slim/inline_template.html.slim
+homepage: https://github.com/kyleshevlin/componentize
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Generator for inline and block level Rails components. Similar to Ember's
+  component generator.
+test_files: []