kentucky 0.1.0

data/lib/kentucky.rb

@@ -0,0 +1,27 @@
+# CodeKit needs relative paths
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
+
+require "kentucky/generator"
+
+unless defined?(Sass)
+  require 'sass'
+end
+
+module Kentucky
+  if defined?(Rails) && defined?(Rails::Engine)
+    class Engine < ::Rails::Engine
+      require 'kentucky/engine'
+    end
+
+    module Rails
+      class Railtie < ::Rails::Railtie
+        rake_tasks do
+          load "tasks/install.rake"
+        end
+      end
+    end
+  else
+    Sass.load_paths << File.expand_path("../../app/assets/stylesheets", __FILE__)
+  end
+end

data/lib/kentucky/engine.rb

@@ -0,0 +1,5 @@
+module Kentucky
+  class Engine < Rails::Engine
+    # auto wire
+  end
+end

data/lib/kentucky/generator.rb

@@ -0,0 +1,132 @@
+require 'kentucky/version'
+require "fileutils"
+require 'thor'
+
+module Kentucky
+  class Generator < Thor
+    map ['-v', '--version'] => :version
+
+    desc 'install', 'Install Kentucky into your project'
+    method_options :path => :string, :force => :boolean, :dir => :boolean
+    def install
+      if kentucky_files_already_exist? && !options[:force]
+        puts "Kentucky files already installed, doing nothing."
+      else
+        create_site_structure if !options[:force]
+        install_deps
+        install_files
+        puts "Kentucky files installed to #{install_path_kentucky}/"
+      end
+    end
+
+    desc 'update', 'Update Kentucky'
+    method_options :path => :string
+    def update
+      if kentucky_files_already_exist?
+        remove_kentucky_directory
+        create_kentucky_directory
+        install_files
+        puts "Kentucky files updated."
+      else
+        puts "No existing Kentucky installation. Doing nothing."
+      end
+    end
+
+    desc 'version', 'Show Kentucky version'
+    def version
+      say "Kentucky #{Kentucky::VERSION}"
+    end
+
+    private
+
+    def kentucky_files_already_exist?
+      install_path_kentucky.exist?
+    end
+
+    def create_site_structure
+      make_install_directory
+      if options[:dir]
+        dirs = %w(fonts images scripts scss style)
+        dirs.each do |dir|
+          FileUtils.mkdir(install_path + Pathname.new(dir))
+        end
+      end
+      create_kentucky_directory
+    end
+
+    def make_install_directory
+      FileUtils.mkdir_p(install_path)
+    end
+
+    def create_kentucky_directory
+      FileUtils.mkdir(install_path_kentucky)
+    end
+
+    def remove_kentucky_directory
+      FileUtils.rm_rf(install_path_kentucky)
+    end
+
+    def install_path
+      if options[:path]
+        path = Pathname.new(options[:path])
+      else
+        path = Pathname.new('.')
+      end
+
+      @install_path = path
+      return path
+    end
+
+    def install_files
+      copy_in_scss_files
+    end
+
+    def install_deps
+      Dir.chdir install_path_scss do
+        `bourbon install`
+        `neat install`
+      end
+    end
+
+    def copy_in_scss_files
+      FileUtils.cp_r(kentucky_stylesheets, install_path_kentucky)
+      FileUtils.cp(master_stylesheet, install_path_scss)
+    end
+
+    def install_path_scss
+      if options[:dir]
+        return install_path + Pathname.new("scss")
+      else
+        return install_path
+      end
+    end
+
+    def install_path_kentucky
+      return install_path_scss + Pathname.new("kentucky")
+    end
+
+    def master_stylesheet
+      Dir["#{stylesheets_directory}/style.scss"]
+    end
+
+    def kentucky_stylesheets
+      Dir["#{kentucky_directory}/*"]
+    end
+
+    def all_stylesheets
+      Dir["#{stylesheets_directory}/*"]
+    end
+
+    def kentucky_directory
+      File.join(stylesheets_directory, "kentucky")
+    end
+
+    def stylesheets_directory
+      File.join(top_level_directory, "app", "assets", "stylesheets")
+    end
+
+    def top_level_directory
+      File.dirname(File.dirname(File.dirname(__FILE__)))
+    end
+  end
+end

data/lib/kentucky/version.rb

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

data/lib/tasks/install.rake

@@ -0,0 +1,20 @@
+# Needed for pre-3.1.
+
+require "fileutils"
+require "find"
+
+namespace :kentucky do
+  desc "Move files to the Rails assets directory."
+  task :install, [:sass_path] do |t, args|
+    args.with_defaults(:sass_path => 'public/stylesheets/sass')
+    source_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+    FileUtils.mkdir_p("#{Rails.root}/#{args.sass_path}/kentucky")
+    FileUtils.cp_r("#{source_root}/app/assets/stylesheets/.", "#{Rails.root}/#{args.sass_path}/kentucky", { :preserve => true })
+    Find.find("#{Rails.root}/#{args.sass_path}/kentucky") do |path|
+      if path.end_with?(".css.scss")
+        path_without_css_extension = path.gsub(/\.css\.scss$/, ".scss")
+        FileUtils.mv(path, path_without_css_extension)
+      end
+    end
+  end
+end

data/readme.md

@@ -0,0 +1,62 @@
+# Kentucky
+###### Straight from the source.
+
+***
+
+## What is Kentucky?
+Kentucky is LookThink's contribution to further enhance an already stellar SCSS library put together by the people at [ThoughtBot](http://www.thoughtbot.com/). Their mixin library, [Bourbon](http://bourbon.io/), and grid system, [Neat](http://neat.bourbon.io/), now serve as the base to all LookThink projects.
+
+Kentucky also includes a variety of mixins from various projects that we find useful and weren't included in Bourbon. Additionally, it includes a handy-dandy file (_defaults.scss) for handling all of your variables, keeping them centralized and easy to maintain.
+
+***
+
+## What's changed?
+LookThink now uses SCSS exclusively as it's CSS preprocessor language of choice. The previous framework was written in LESS and we've taken steps to continually evolve how we code projects.
+
+We've also lessened the maintenance burden by relying on libraries that already exist and do the exact same things our previous framework did. The new method for acquiring the framework also means you'll always have the most up to date version of the components.
+
+Lastly, we've opened a Trello board for all feedback, issue / bug reporting, and additions to the framework. You can track it's growth as well as alert us to potential or existing problems in Kentucky.
+
+***
+
+## How do I get Kentucky?
+There are a few steps needed to build the new framework. Luckily for you we've automated as much as we can and all you have to do is copy-paste (or type if you're so inclined) a few lines into your terminal and you're set!
+
+If you need to navigate to your project folder in the Terminal, use the `cd` command to get to your project folder: `$ cd projects-base/project/build`.
+
+The simplest way to get Kentucky is to navigate to your project's SCSS folder, open Terminal and type:
+
+		$ kentucky install
+		
+This will install Bourbon, Neat, and Kentucky in nice little folders ready for you to use. All you need to do is add a folder for your partials, pages, or whatever you need and get to coding!
+
+Kentucky also comes with a few options to make your life easier in particular situations.
+
+If you need a full project structure (fonts, images, etc.), navigate to your project folder, open Terminal:
+
+		$ kentucky install --dir
+		
+This will create **fonts**, **images**, **SCSS**, **style**, and **scripts** folders in your project folder. It then installs Kentucky inside of the created SCSS folder! Super easy, right?!
+
+The last option is for you Terminal pro's. Kentucky includes the capability to create your project folder, tell Kentucky where it is, and install it there, *without* needing to `cd` there. To do this open Terminal:
+
+		$ mkdir -p projects-base/project/build
+		$ kentucky install --path=projects-base/project/build --dir
+
+This creates your project folder, creates all required folders inside of that folder, and installs Kentucky! Boom! This is also runnable without the `--dir` option if all you need is to point Kentucky to the project from anywhere but the project folder, `$ kentucky install --patch=projects-base/project/build/scss`. 
+
+Once Kentucky is installed, navigate to the project folder, open Terminal and run:
+
+		$ sass --watch scss/style.scss:style/style.css
+		
+Leave Terminal open and whenever you make a change to your SCSS files, it will compile a new style.css for you.
+
+***
+
+## Need help?
+Fear not! Bourbon and Neat are fully documented and easy to follow. Need more general help? The SCSS documentation isn't grand, but it's better than not having any. See the list below for help with coding out your projects!
+
++ [Official SCSS Reference](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#)
++ [Bourbon Documentation](http://bourbon.io/docs/)
++ [Neat Documentation](http://neat.bourbon.io/docs/)
++ *Updated code manual coming soon!*

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: kentucky
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Clemmer
+- Greg Bruening
+- Chris Brinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bourbon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: neat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.11
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: |
+  Kentucky is LookThink's contribution to further enhance an already stellar SCSS library put together by the people at ThoughtBot. Their mixin library (Bourbon) and grid system (Neat) now serve as the base to all LookThink projects. Kentucky also includes a variety of mixins from various projects that we find useful and weren't included in Bourbon. Additionally, it includes a handy-dandy file (_defaults.scss) for handling all of your variables, keeping them centralized and easy to maintain.
+email:
+- greg@lookthink.com
+executables:
+- kentucky
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- app/assets/stylesheets/kentucky/_debug.scss
+- app/assets/stylesheets/kentucky/_defaults.scss
+- app/assets/stylesheets/kentucky/_helpers.scss
+- app/assets/stylesheets/kentucky/_kentucky.scss
+- app/assets/stylesheets/kentucky/_normalize.scss
+- app/assets/stylesheets/kentucky/_shame.scss
+- app/assets/stylesheets/style.scss
+- bin/kentucky
+- features/install.feature
+- features/step_definitions/kentucky_steps.rb
+- features/support/env.rb
+- features/support/kentucky_support.rb
+- features/update.feature
+- features/version.feature
+- kentucky.gemspec
+- lib/kentucky.rb
+- lib/kentucky/engine.rb
+- lib/kentucky/generator.rb
+- lib/kentucky/version.rb
+- lib/tasks/install.rake
+- readme.md
+homepage: https://bitbucket.org/lookthink/kentucky
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Kentucky Bourbon, Neat SCSS Mixins and Grid System
+test_files:
+- features/install.feature
+- features/step_definitions/kentucky_steps.rb
+- features/support/env.rb
+- features/support/kentucky_support.rb
+- features/update.feature
+- features/version.feature