amcss-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 838da3f9febc9919156f618ba2ed77674ef3cbb4
+  data.tar.gz: 199c41bca0326f56adc22831f2cfea09d4146bd1
+SHA512:
+  metadata.gz: 2ef0d5c640088115a3e92f9966598ec97985fd4f16e1ffb0f6fc84509c3602615e8242be4bcb6aa94a01a51ef2740be0dba5107085363626d103e3e4b9993c51
+  data.tar.gz: c8ae610b27576daba71259d4bbb96ffa87a2860d0f04bf33197eb03110543f420334e72c83ddc9ddff5854aedd71ed9816e7fff0e8ff605570a0de66d274a568

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in amcss-rails.gemspec
+gemspec
+
+gem 'amcss', path: "./../amcss"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Silvano Stralla
+
+MIT License
+
+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,115 @@
+# Amcss::Rails
+
+amcss-rails makes [amcss](https://github.com/sistrall/amcss) available in Rails (don't know amcss? Take a look at  [README](https://github.com/sistrall/amcss/blob/master/README.md)).
+
+Shortly: you write this...
+
+```haml
+= am(:box) do |b|
+  = b.am(:header) do
+    Header
+  = b.am(:content) do
+    Body
+```
+
+...and get this:
+
+```html
+<div data-am-box>
+  <div data-am-box__header>Header</div>
+  <div data-am-box__content>Content</div>
+</div>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amcss-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amcss-rails
+
+## Usage
+
+amcss-rails allows you to use helper in your views like this:
+
+```erb
+<%= am('Calendar', variation: 'flat') do %>
+  <p>Hi, I'm a calendar</p>
+<% end %>
+```
+
+What you'll get is a `div` with AMCSS attribute:
+
+```html
+<div am-Calendar="flat">
+  <p>Hi, I'm a calendar</p>
+</div>
+```
+
+It seems nothing, but the interesting part comes when you try to nest blocks and add a little bit of configuration. Take a look.
+
+Create 2 initializer files:
+
+```ruby
+# In config/initializers/amcss.rb
+Amcss.configure do |configuration|
+  configuration.prefix = :data
+end
+```
+
+```ruby
+# In config/initializers/amcss-rails.rb
+Amcss::Rails::Engine.configure do |engine|
+  engine.config.amcss.style = :bem
+  engine.config.amcss.block_element_separator = '__'
+end
+```
+
+Than write this code in your template:
+
+```erb
+<%= am(:calendar, variation: 'flat') do |calendar| %>
+  <%= calendar.am(:header, variation: 'padded') do %>
+    Header
+  <% end %>
+  <%= calendar.am(:body) do %>
+    Body
+  <% end %>
+<% end %>
+```
+
+This is what you get:
+
+```html
+<div data-am-calendar="flat">
+  <div data-am-calendar__header="padded"></div>
+  <div data-am-calendar__body=""></div>
+</div>
+```
+
+Even easier to read if you are a HAML fan:
+
+```haml
+= am(:calendar, variation: 'flat') do |calendar|
+  = calendar.am(:header, variation: 'padded') do
+    Header
+  = calendar.am(:body) do
+    Body
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/amcss-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/amcss-rails.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amcss/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amcss-rails"
+  spec.version       = Amcss::Rails::VERSION
+  spec.authors       = ["Silvano Stralla"]
+  spec.email         = ["silvano.stralla@sistrall.it"]
+  spec.summary       = %q{AMCSS for Rails}
+  spec.description   = %q{Define a series of helpers to make it easy to use AMCSS in Rails project}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'amcss'
+  spec.add_dependency 'rails'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'combustion'
+end

data/app/helpers/amcss/rails/application_helper.rb

@@ -0,0 +1,47 @@
+module Amcss::Rails::ApplicationHelper
+  def am(m, content_or_options_with_block = nil, options = nil, escape = true, &block)
+    options = case
+      when content_or_options_with_block.is_a?(Hash) then content_or_options_with_block
+      when options.is_a?(Hash) then options
+      else {}
+    end
+
+    options_with_amcss_attribute = am_options(m, options)
+
+    klass = "amcss/rails/application_helper/#{Amcss::Rails::Engine.config.amcss.style}_style_am_module_or_trait".classify.constantize
+
+    content = block_given? ? capture(klass.new(self, m), &block) : content_or_options_with_block
+
+    content_tag(:div, content, options_with_amcss_attribute, escape)
+  end
+
+  def am_options(m, options = {})
+    attribute = Amcss::Html::Attribute.from(m, *(options[:variation] || options[:variations]))
+
+    options
+      .except(:variation, :variations)
+      .merge(attribute)
+  end
+
+  class AmModuleOrTrait < Struct.new(:template, :m)
+    def am(*args, &block)
+      template.am(*args, &block)
+    end
+  end
+
+  class AmcssStyleAmModuleOrTrait < AmModuleOrTrait
+  end
+
+  class BemStyleAmModuleOrTrait < AmModuleOrTrait
+    def am(*args, &block)
+      template.am(*module_element(args), &block)
+    end
+
+    private
+      def module_element(args)
+        element = args.shift
+
+        ["#{m}#{Amcss::Rails::Engine.config.amcss.block_element_separator}#{element}"] + args
+      end
+  end
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/amcss/rails.rb

@@ -0,0 +1,9 @@
+require "amcss/rails/version"
+require "amcss/rails/helper"
+require "amcss/rails/engine"
+
+module Amcss
+  module Rails
+  end
+end
+

data/lib/amcss/rails/engine.rb

@@ -0,0 +1,21 @@
+module Amcss::Rails
+  class Engine < ::Rails::Engine
+    isolate_namespace Amcss::Rails
+
+    config.amcss = ActiveSupport::OrderedOptions.new
+    config.amcss.style = :bem
+
+    initializer 'amcss-rails.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        ### (§)
+        #
+        # Makes all helpers to be avaiblable in the main app.
+        #
+        # See: http://stackoverflow.com/a/9641149
+        #
+        helper Amcss::Rails::ApplicationHelper
+      end
+    end
+  end
+end
+

data/lib/amcss/rails/helper.rb

@@ -0,0 +1,5 @@
+module Amcss::Rails::Helper
+  def am(modüle, *variations_or_traits, &block)
+    content_tag(:div, {}, &block)
+  end
+end

data/lib/amcss/rails/version.rb

@@ -0,0 +1,5 @@
+module Amcss
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/spec/amcss/rails_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Amcss::Rails do
+  it 'has a version number' do
+    expect(Amcss::Rails::VERSION).not_to be nil
+  end
+end

data/spec/helpers/amcss/rails/application_helper_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+# = am('author-experience') do |m|
+#   = m.am('header') do
+#     Best practice of the author
+
+# = am('counter', mod: 'check-ins') do |n|
+#   = n.am('icon') do
+#     Content
+
+# = am('best-practice-card', for: %w{am js}) do
+#   Content
+
+RSpec.describe Amcss::Rails::ApplicationHelper, type: :helper do
+  describe "#am" do
+    it 'supports symbols' do
+      expect(helper.am(:Calendar, 'Monthly calendar', variations: %i{big flat}))
+        .to eq '<div am-Calendar="big flat">Monthly calendar</div>'
+    end
+
+    it 'supports strings' do
+      expect(helper.am('Calendar', 'Monthly calendar', variation: 'big'))
+        .to eq '<div am-Calendar="big">Monthly calendar</div>'
+    end
+
+    it 'supports passing options' do
+      expect(helper.am('Calendar', 'Monthly calendar', variation: 'big', class: 'bootstrap-class', style: "You know you should not inline style!"))
+        .to match_html <<-HTML
+          <div class="bootstrap-class" style="You know you should not inline style!" am-Calendar="big">
+            Monthly calendar
+          </div>
+        HTML
+      end
+
+    context "without blocks" do
+      it "returns a div tag" do
+        expect(helper.am('Calendar', 'Monthly calendar'))
+          .to eq '<div am-Calendar="">Monthly calendar</div>'
+
+        expect(helper.am('Calendar', 'Monthly calendar', variation: 'big'))
+          .to eq '<div am-Calendar="big">Monthly calendar</div>'
+
+        expect(helper.am('Calendar', 'Monthly calendar', variations: 'small rounded'))
+          .to eq '<div am-Calendar="small rounded">Monthly calendar</div>'
+
+        expect(helper.am('Calendar', 'Monthly calendar', variations: %w{small rounded}))
+          .to eq '<div am-Calendar="small rounded">Monthly calendar</div>'
+      end
+    end
+
+    context "with blocks" do
+      it "returns a div tag" do
+        expect(helper.am('Calendar') {})
+          .to eq '<div am-Calendar=""></div>'
+
+        expect(helper.am('Calendar', variation: 'big') {})
+          .to eq '<div am-Calendar="big"></div>'
+
+        expect(helper.am('Calendar', variations: 'small rounded') {})
+          .to eq '<div am-Calendar="small rounded"></div>'
+
+        expect(helper.am('Calendar', variations: %w{small rounded}) {})
+          .to eq '<div am-Calendar="small rounded"></div>'
+      end
+    end
+
+    context "nested usage" do
+      it "returns a div within a div" do
+        expect(helper.am('Calendar') { |m|
+          m.am('CalendarHeader') {}
+        }).to match_html <<-HTML
+          <div am-Calendar="">
+            <div am-CalendarHeader=""></div>
+          </div>
+        HTML
+      end
+
+      it "returns nested divs" do
+        expect(helper.am('Calendar', variation: 'flat') { |m|
+          m.am('CalendarHeader', '', variation: 'padded') + m.am('CalendarBody', '')
+        }).to match_html <<-HTML
+          <div am-Calendar="flat">
+            <div am-CalendarHeader="padded"></div>
+            <div am-CalendarBody=""></div>
+          </div>
+        HTML
+      end
+    end
+
+    context "with gem configuration for data-* attributes" do
+      before(:each) do
+        Amcss.configure do |configuration|
+          configuration.prefix = :data
+        end
+      end
+
+      it 'return HTML with data-am-* attributes' do
+        expect(helper.am(:Calendar, 'Monthly calendar', variation: %i{big flat}))
+          .to eq '<div data-am-Calendar="big flat">Monthly calendar</div>'
+      end
+    end
+
+    context "with gem configuration for BEM style" do
+      before(:each) do
+        Amcss::Rails::Engine.configure do
+          config.amcss.style = :bem
+        end
+      end
+
+      it 'returns HTML with attribute in BEM style (am-block--element)' do
+        expect(helper.am(:calendar, variation: 'flat') { |calendar|
+          calendar.am(:header, '', variation: 'padded') + calendar.am(:body, '')
+        }).to match_html <<-HTML
+          <div am-calendar="flat">
+            <div am-calendar__header="padded"></div>
+            <div am-calendar__body=""></div>
+          </div>
+        HTML
+      end
+    end
+
+    context "with gem configuration for data-* attributes and BEM style" do
+      before(:each) do
+        Amcss.configure do |configuration|
+          configuration.prefix = :data
+        end
+
+        Amcss::Rails::Engine.configure do
+          config.amcss.style = :bem
+        end
+      end
+
+      it 'return HTML with data-am-* attributes in BEM style' do
+        expect(helper.am(:calendar, variation: 'flat') { |calendar|
+          calendar.am(:header, '', variation: 'padded') + calendar.am(:body, '')
+        }).to match_html <<-HTML
+          <div data-am-calendar="flat">
+            <div data-am-calendar__header="padded"></div>
+            <div data-am-calendar__body=""></div>
+          </div>
+        HTML
+      end
+    end
+  end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+ENV["RAILS_ENV"] ||= "test"
+
+require 'rubygems'
+
+require 'bundler/setup'
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each { |f| require f }
+
+require 'combustion'
+
+Combustion.initialize! :action_controller, :action_view
+
+require 'rspec/rails'
+
+require 'amcss/rails'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Amcss.configure do |configuration|
+      configuration.prefix = nil
+    end
+
+    Amcss::Rails::Engine.configure do |engine|
+      engine.config.amcss.style = :amcss
+      engine.config.amcss.block_element_separator = '__'
+    end
+  end
+end
+

data/spec/support/matchers/be_rendered_as.rb

@@ -0,0 +1,18 @@
+RSpec::Matchers.define :be_rendered_as do |expected|
+  match do |actual|
+    render(actual) == render(expected)
+  end
+
+  def failure_message
+    "\nexpected: #{expected}\n     got: #{render(actual)}\n\n(compared using ==, after rendering SASS with Sass::Engine)\n"
+  end
+
+  def failure_message_when_negated
+    "\nexpected: value != #{expected}\n     got: #{render(actual)}\n\n(compared using ==, after rendering SASS with Sass::Engine)\n"
+  end
+
+  private
+    def render(sass)
+      Sass::Engine.new(sass, style: :compact, syntax: :scss).render
+    end
+end

data/spec/support/matchers/match_html.rb

@@ -0,0 +1,18 @@
+RSpec::Matchers.define :match_html do |expected|
+  match do |actual|
+    actual == squished_expected
+  end
+
+  def failure_message
+    "\nexpected: #{squished_expected}\n     got: #{actual}\n\n(compared using ==, after removing /\\n\\s+/ and squishing HTML)\n"
+  end
+
+  def failure_message_when_negated
+    "\nexpected: value != #{squished_expected}\n     got: #{actual}\n\n(compared using ==, after removing /\\n\\s+/ and squishing HTML)\n"
+  end
+
+  private
+    def squished_expected
+      expected.gsub(/\n\s+/, '').squish
+    end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: amcss-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Silvano Stralla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amcss
+  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: rails
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  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'
+description: Define a series of helpers to make it easy to use AMCSS in Rails project
+email:
+- silvano.stralla@sistrall.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amcss-rails.gemspec
+- app/helpers/amcss/rails/application_helper.rb
+- config.ru
+- lib/amcss/rails.rb
+- lib/amcss/rails/engine.rb
+- lib/amcss/rails/helper.rb
+- lib/amcss/rails/version.rb
+- spec/amcss/rails_spec.rb
+- spec/helpers/amcss/rails/application_helper_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+- spec/support/matchers/be_rendered_as.rb
+- spec/support/matchers/match_html.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: AMCSS for Rails
+test_files:
+- spec/amcss/rails_spec.rb
+- spec/helpers/amcss/rails/application_helper_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+- spec/support/matchers/be_rendered_as.rb
+- spec/support/matchers/match_html.rb