css_canon 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Johnston
+
+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,64 @@
+# css_canon
+
+Imposes a "canonical" css/sass/[SMACSS][2] structure on a Rails 3.x project.
+
+* Assumes using [Zurb Foundation][1]. Pull requests for Bootstrap or other frameworks welcome.
+* imposes the following directory structures
+
+```
+
+      ├── app
+      │   ├── assets
+      │   │   └── stylesheets
+      │   │       ├── application.css.scss
+      │   │       ├── base.css.scss
+      │   │       ├── foundation_and_overrides.scss
+      │   │       ├── home.css.scss
+      │   │       ├── layout
+      │   │       │   └── grid_additions.css.scss
+      │   │       ├── module
+      │   │       │   └── 
+      │   │       └── vendor_overrides
+      │   │           └── 
+      └── vendor
+          ├── assets
+          │   └── stylesheets
+          │       ├── non_sass
+          │       │   └──
+          │       ├── sass
+          │       │   └──
+          │       └── vendor.css
+
+```
+
+## Example
+For an example rails app using this structure, see [this repo][3]
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'css_canon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install css_canon
+
+## Usage
+
+    rails g css_canon
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+[1]: https://github.com/zurb/foundation "Zurb Foundation"
+[2]: http://smacss.com "Scalable and Modular Architecture for CSS"
+[3]: https://github.com/lastobelus/assets_css_structure "Example Rails app using the css_canon setup"

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/css_canon.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'css_canon/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "css_canon"
+  gem.version       = CssCanon::VERSION
+  gem.authors       = ["Michael Johnston"]
+  gem.email         = ["lastobelus@mac.com"]
+  gem.description   = %q{Imposes a "canonical" css/sass/SMACSS structure on a Rails 3.x project.}
+  gem.summary       = %q{Imposes a "canonical" css/sass/SMACSS structure on a Rails 3.x project.}
+  gem.homepage      = "https://github.com/lastobelus/css_canon"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency  "zurb-foundation", "~> 3.2.0"
+
+end

data/lib/css_canon/generators/install_generator.rb

@@ -0,0 +1,46 @@
+module CssCanon
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.join(File.dirname(__FILE__), 'templates')
+      desc 'imposes a canonical css structure'
+    
+      def install_foundation_if_not_installed
+        unless File.exists?("app/assets/stylesheets/foundation_and_overrides.scss") 
+          generate "foundation:install"
+        end
+      end
+
+      def copy_app_asset_templates
+        say "setting up app/assets/stylesheets..."
+        if File.exists? "app/assets/stylesheets/application.css"
+          File.rename "app/assets/stylesheets/application.css", "app/assets/stylesheets/TO_MIGRATE.css"
+        end
+        copy_file "app/assets/stylesheets/application.css.scss"
+        copy_file "app/assets/stylesheets/base.css.scss"
+        directory "app/assets/stylesheets/layout"
+        directory "app/assets/stylesheets/module"
+      end
+
+      def copy_vendor_asset_templates
+        say "setting up vendor/assets/stylesheets..."
+        copy_file "vendor/assets/stylesheets/vendor.css.scss"
+      end
+
+      def modify_zurb_overrides_file
+        say "adding example use of brand variables to foundation_and_overrides..."
+        foundation_file  = "app/assets/stylesheets/foundation_and_overrides.scss"
+        color_example_regex = %r{^ *// *\$mainColor:.*}
+        our_color_example = <<-EOCSS
+\n// override foundation variables with variables defined in base.css.scss,
+// so that branding can easily be changed in a single place
+// $mainColor: $brandOne;"
+          EOCSS
+        if File.readlines(foundation_file).grep(color_example_regex).size > 0
+          gsub_file foundation_file, color_example_regex, our_color_example
+        else
+          inject_into_file foundation_file, our_color_example, after: %r{// Colors Settings}
+        end
+      end
+    end
+  end
+end

data/lib/css_canon/generators/templates/app/assets/stylesheets/application.css.scss

@@ -0,0 +1,23 @@
+//  non-sass files go in vendor/assetts/stylesheets/application
+//  and vendor/assetts/stylesheets/vendor.css does a require_tree  .
+//= require vendor
+//= require_self
+
+// site/brand specific sass variables go here
+@import "base";
+// here foundation variables are set to values defined in base
+@import "foundation_and_overrides";
+
+// overrides/customizations of vendor libs go here. 
+// If possible they should be independent, so this can be left as a blob
+ @import "vendor_overrides/**/*";
+
+// styles which build on basic foundation layouts. 
+// Should use SMACSS -- if the glob stops working 
+// consider that a css code smell
+@import "layout/**/*";
+
+// styles which build modules.
+// Should use SMACSS -- if the glob stops working 
+// consider that a css code smell
+@import "module/**/*";

data/lib/css_canon/generators/templates/app/assets/stylesheets/base.css.scss

@@ -0,0 +1,6 @@
+// Place sass variable here, and then refer to those variables in other sass files.
+// This makes branding easier and in one place.
+
+// $brandOne: orange;
+// $brandTwo: green;
+// $brandThree: pink;

data/lib/css_canon/generators/templates/app/assets/stylesheets/module/README

@@ -0,0 +1,3 @@
+# Modules
+Include files here that define modules for your app (see http://smacss.com)
+These files are imported after base.css.scss and foundation_overrides.css.scss, so they can use sass variables/mixins defined there

data/lib/css_canon/generators/templates/app/assets/stylesheets/vendor_overrides/README

@@ -0,0 +1,2 @@
+Include files here that override styles in vendored css, with a file or directory with a name matching the name of the directory in vendor/assets/stylesheets that contains the 3rd-party css
+These files are imported after base.css.scss and foundation_overrides.css.scss, so they can use sass variables/mixins defined there

data/lib/css_canon/generators/templates/vendor/assets/stylesheets/vendor.css.scss

@@ -0,0 +1,3 @@
+//= require_tree ./non_sass
+
+@import "sass/**/*"

data/lib/css_canon/version.rb

@@ -0,0 +1,3 @@
+module CssCanon
+  VERSION = "0.0.1"
+end

data/lib/css_canon.rb

@@ -0,0 +1,6 @@
+require "css_canon/version"
+
+
+if defined?(Rails)
+  require "css_canon/generators/install_generator"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: css_canon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Johnston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zurb-foundation
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Imposes a "canonical" css/sass/SMACSS structure on a Rails 3.x project.
+email:
+- lastobelus@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- css_canon.gemspec
+- lib/css_canon.rb
+- lib/css_canon/generators/install_generator.rb
+- lib/css_canon/generators/templates/app/assets/stylesheets/application.css.scss
+- lib/css_canon/generators/templates/app/assets/stylesheets/base.css.scss
+- lib/css_canon/generators/templates/app/assets/stylesheets/layout/grid_additions.css.scss
+- lib/css_canon/generators/templates/app/assets/stylesheets/module/README
+- lib/css_canon/generators/templates/app/assets/stylesheets/vendor_overrides/README
+- lib/css_canon/generators/templates/vendor/assets/stylesheets/vendor.css.scss
+- lib/css_canon/version.rb
+homepage: https://github.com/lastobelus/css_canon
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2663183119578062736
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2663183119578062736
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Imposes a "canonical" css/sass/SMACSS structure on a Rails 3.x project.
+test_files: []