kentucky 2.2.2 → 3.0.0

data/app/assets/stylesheets/vendors/README

@@ -0,0 +1,12 @@
+From sass-guidelin.es:
+
+And last but not least, most projects will have a vendors/ folder containing all the CSS files from external libraries and frameworks – Normalize, Bootstrap, jQueryUI, FancyCarouselSliderjQueryPowered, and so on. Putting those aside in the same folder is a good way to say “Hey, this is not from me, not my code, not my responsibility”.
+
+    _normalize.scss
+    _bootstrap.scss
+    _jquery-ui.scss
+    _select2.scss
+
+If you have to override a section of any vendor, I recommend you have an 8th folder called vendors-extensions/ in which you may have files named exactly after the vendors they overwrite.
+
+For instance, vendors-extensions/_bootstrap.scss is a file containing all CSS rules intended to re-declare some of Bootstrap’s default CSS. This is to avoid editing the vendor files themselves, which is generally not a good idea.

data/kentucky.gemspec

@@ -23,8 +23,8 @@ Kentucky is a class-independent front-end framework built as a standard project
   s.require_paths = ["lib"]
 
   s.add_dependency('sass', '~> 3.4')
-  s.add_dependency('thor', '>= 0')
+  s.add_dependency('thor', '~> 0')
 
-  s.add_development_dependency('aruba', '>= 0')
-  s.add_development_dependency('rake', '>= 0')
+  s.add_development_dependency('aruba', '= 0.4.11')
+  s.add_development_dependency('rake', '~> 0')
 end

data/lib/kentucky/generator.rb

@@ -45,7 +45,7 @@ module Kentucky
     def create_site_structure
       make_install_directory
       if options[:dir]
-        dirs = %w(images scripts scss css)
+        dirs = %w(fonts images scripts scss style)
         dirs.each do |dir|
           FileUtils.mkdir(install_path + Pathname.new(dir))
         end

data/lib/kentucky/version.rb

@@ -1,3 +1,3 @@
 module Kentucky
-  VERSION = "2.2.2"
+  VERSION = "3.0.0"
 end

data/readme.md

@@ -3,140 +3,47 @@
 
 [![Gem Version](https://badge.fury.io/rb/kentucky.png)](http://badge.fury.io/rb/kentucky)
 
-###### CHANGELOG
+**Kentucky is a front-end project kickstart system to allow for rapidly beginning CSS development on a myriad of projects.**
 
-*2.2.2* - Update generated folders when using `-dir` option
-*2.2.0* - Update dependencies and code styles
-*2.1.0* - Update file semantics to match custom LookThink linter
+At its core, Kentucky itself provides no initial CSS other than a slightly modified [Normalize.css](https://necolas.github.io/normalize.css/) and typographic styles dictated by the `utilities/variables` file.
 
-***
+It's meant to provide SCSS structure and guidance to ensure projects remain clean and well-organized from the beginning while allowing developers full freedom to use whatever naming conventions, methodologies, and HTML structure required for the project.
 
-Kentucky was originally an additional library to use with Bourbon as our developers ventured into the realm of front-end frameworks. As time progressed and more frameworks emerged from all corners of the internet it became clear we needed to create our own.
+---
 
-Kentucky is meant to serve as a leaping point for front-end projects. It has no grid system (flexbox is simple enough without complicated DOM cluttering of classes) and is based entirely on the SCSS side of projects. Our framework is invisible to the end user inspecting elements on your site. This leaves developers completely open to use any form of semantics for classes as they're comfortable with.
+# Core structure
+## Base
 
-Below is some base documentation into what is included in Kentucky.
+The `base/` folder includes two files to start with: `normalize` for increasing expected results and `typography` to apply the variables set in `utilities/variables` to typographic elements. Once created, the files in this folder should rarely be edited unless a fundamental shift in the project design is required.
 
-***
+Additional files to be added to this folder could include: `forms`, `tables`, etc.
 
-### Base
+## Components
 
-##### Project Settings
-This file serves as the starting point for all projects. Full of default values for typography, spacing, colors, etc. it's the perfect place to store global, project-specific variables to use throughout your project.
+The `components/` folder may contain specific modules like a slider, a loader, a widget, or  anything along those lines. There should typically be a lot of files in `components` since the whole site/application should be mostly composed of tiny modules.
 
-##### Layouts
-A very barebones file meant to serve as a place to keep global layout-related styles.
+Example files to be included in this folder could include: `buttons`, `dropdown`, `media`, `thumbnails`, etc.
 
-##### Typography
-Slightly deceiving in name, but houses general typography / main content styles and normalization. This is where a majority of the variables (related to typography) in *_project-settings.scss* are called. 
+## Layout
 
-##### Buttons
-Normalization of all button-style inputs and serves as a location where project-wide button styles can live.
+The `layout/` folder contains everything that takes part in laying out the site or application. This folder could have stylesheets for the main parts of the site (header, footer, navigation, sidebar) and/or the site grid system (if custom; vendor grid systems should be included in `vendors/`).
 
-##### Forms
-Normalization of form elements.
+Example files to be included in this folder could include: `header`, `footer`, `hero`, `grid`, etc.
 
-##### Lists
-Normalization of unordered / ordered lists as well as definition lists. Also includes placeholder extends `%default-ul` and `%default-ol` that can applied to `ul` and `ol` elements that re-add the default list-styles for both as well as some margin/padding.
+## Pages
 
-##### Tables
-Normalization of table elements.
+The `pages/` folder is for page-specific styles. Each file in this folder should be named after the page it relates to.
 
+Example files to be included in this folder could include: `home`, `blog`, `about`, `contact`, etc.
 
-### Addons
+## Utilities
 
-##### Border
-A simple mixin that allows users to define unequal border widths inline with border style and color.
+The `utilities/` folder gathers all Sass tools and helpers used across the project. Every global variable, function, mixin and placeholder should be put in here. It already includes `functions`, `mixins`, and `variables` to help jumpstart the process.
 
-*Usage Example:*
+Example files to be included in this folder could include: `fonts`, `icons`, `media-queries`, etc.
 
-```SCSS
-@include border(1px 2px 5px, solid, #b4d455);
-```
+## Vendors
 
-##### Clearfix
-Simple mixin to call the super-micro clearfix snippet based on Theirry Koblentz's minification of Nicolas Gallagher's micro clearfix.
+The `vendors/` folder is to ensure any external libraries or frameworks remain separated from the core site styles. If you require vendor overrides, it's encouraged to make another folder (within the root SCSS folder) called `vendor-extensions` to keep vendor files intact should they release updates.
 
-*Usage Example:*
-
-```SCSS
-@include clearfix;
-```
-
-##### Easings
-Variable-based timing functions to be used in transition / animation styles.
-
-*Usage Example:*
-
-```SCSS
-.selector {
-  transition: all .5s #{$ease-in-quad};
-}
-```
-
-##### Hide Text
-Simple mixin to "hide text" in a new method, akin to the old -9999px hack to move text off of image replaced objects.
-
-*Usage Example:*
-
-```SCSS
-@include hide-text;
-```
-
-##### Input Types
-Primarily created for usage in the button / form normalization files but these can be used to target all button / text inputs at once without having to list each individually.
-
-*Usage Example:*
-
-```SCSS
-#{$all-button-inputs} {
-  margin-bottom: 20px;
-}
-```
-
-##### Position
-Akin to the border mixin, this allows users to include the type of positioning and coordinates in a single line.
-
-```SCSS
-@include position(absolute, 10px 20px 0 0);
-```
-
-*Note that all four values are required.*
-
-
-##### Size
-A dead simple mixin allowing users to set the width / height on a single line.
-
-```SCSS
-@include size(15px 20px);
-```
-
-*A single value will print the same value for width and height.*
-
-```SCSS
-@include size(20px);
-```
-
-
-##### Truncate
-Mixin that allows single-line, CSS-based truncation with an ellipsis. Requires a width value.
-
-```SCSS
-@include truncate(300px);
-```
-
-
-### Functions
-
-##### Assign
-Used in the input types addon. Usage is fairly minimal outside of that.
-
-##### Tint / Shade
-An improvement to the typical `darken` / `lighten` abilities of SCSS. Tint and shade add white / black respectively to create richer colors.
-
-```SCSS
-.selector {
-  background-color: tint(#b4d455, 5%);
-  color: shade($brand-color, 10%);
-}
-```
+Example folders and files to be included in this folder include: `bootstrap/files`, `susy/files`, `js-plugin/files`, etc.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kentucky
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Aaron Clemmer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -30,42 +30,42 @@ dependencies:
   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'
+        version: 0.4.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        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 a class-independent front-end framework built as a standard
@@ -85,24 +85,16 @@ files:
 - Gemfile.lock
 - LICENSE
 - Rakefile
-- app/assets/stylesheets/kentucky/_kentucky.scss
-- app/assets/stylesheets/kentucky/addons/_border.scss
-- app/assets/stylesheets/kentucky/addons/_clearfix.scss
-- app/assets/stylesheets/kentucky/addons/_easings.scss
-- app/assets/stylesheets/kentucky/addons/_hide-text.scss
-- app/assets/stylesheets/kentucky/addons/_input-types.scss
-- app/assets/stylesheets/kentucky/addons/_position.scss
-- app/assets/stylesheets/kentucky/addons/_size.scss
-- app/assets/stylesheets/kentucky/addons/_truncate.scss
-- app/assets/stylesheets/kentucky/base/_buttons.scss
-- app/assets/stylesheets/kentucky/base/_forms.scss
-- app/assets/stylesheets/kentucky/base/_layouts.scss
-- app/assets/stylesheets/kentucky/base/_lists.scss
-- app/assets/stylesheets/kentucky/base/_project-settings.scss
-- app/assets/stylesheets/kentucky/base/_tables.scss
-- app/assets/stylesheets/kentucky/base/_typography.scss
-- app/assets/stylesheets/kentucky/functions/_assign.scss
-- app/assets/stylesheets/kentucky/functions/_tint-shade.scss
+- app/assets/stylesheets/base/_normalize.scss
+- app/assets/stylesheets/base/_typography.scss
+- app/assets/stylesheets/components/README
+- app/assets/stylesheets/layout/README
+- app/assets/stylesheets/pages/README
+- app/assets/stylesheets/project.scss
+- app/assets/stylesheets/utilities/_functions.scss
+- app/assets/stylesheets/utilities/_mixins.scss
+- app/assets/stylesheets/utilities/_variables.scss
+- app/assets/stylesheets/vendors/README
 - bin/kentucky
 - features/install.feature
 - features/step_definitions/kentucky_steps.rb
@@ -137,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: SCSS project base and mixin library.

data/app/assets/stylesheets/kentucky/_kentucky.scss

@@ -1,52 +0,0 @@
-// ------------------------------------------------------------------- //
-//  Kentucky Project Settings
-//  
-//  Global variables used throughout Kentucky / projects.
-// ------------------------------------------------------------------- //
-
-@import "base/project-settings";
-
-
-
-// ------------------------------------------------------------------- //
-//  Kentucky Imports - Functions
-//  
-//  SCSS functions required by other elements of Kentucky.
-// ------------------------------------------------------------------- //
-
-@import "functions/assign";
-@import "functions/tint-shade";
-
-
-
-// ------------------------------------------------------------------- //
-//  Kentucky Import - Addons
-//  
-//  Additional mixin addons to help speed up front-end development.
-// ------------------------------------------------------------------- //
-
-@import "addons/border";
-@import "addons/clearfix";
-@import "addons/easings";
-@import "addons/hide-text";
-@import "addons/input-types";
-@import "addons/position";
-@import "addons/size";
-@import "addons/truncate";
-
-
-
-// ------------------------------------------------------------------- //
-//  Kentucky Imports - Base
-//  
-//  These are files related to project-settings (variables) and a
-//  custom set of normalization styles for more consistant HTML
-//  element display as a starting point.
-// ------------------------------------------------------------------- //
-
-@import "base/layouts";
-@import "base/typography";
-@import "base/buttons";
-@import "base/forms";
-@import "base/lists";
-@import "base/tables";

data/app/assets/stylesheets/kentucky/addons/_border.scss

@@ -1,30 +0,0 @@
-// ------------------------------------------------------------------- //
-//  Border Mixin
-//
-//  For use in instances where multiple border-widths are required
-// ------------------------------------------------------------------- //
-
-@mixin border($border-width, $border-style: solid, $border-color: black) {
-  // if too many widths, throw error
-  @if (length($border-width) > 4) {
-    @warn "Border-width accepts a maximum of 4 width parameters;  #{length($border-width)} found.";
-  }
-
-  // New border width list
-  $new-width: ();
-
-  // Populate it
-  @for $i from 1 through length($border-width) {
-
-    // If border is unitless, append unit
-    @if unitless(nth($border-width, $i)) {
-      $new-width: append($new-width, nth($border-width, $i) + px);
-    } @else {
-      $new-width: append($new-width, nth($border-width, $i));
-    }
-  }
-
-  border-style: $border-style;
-  border-color: $border-color;
-  border-width: $new-width;
-}

data/app/assets/stylesheets/kentucky/addons/_clearfix.scss

@@ -1,14 +0,0 @@
-// ------------------------------------------------------------------- //
-//  Micro Clearfix
-//  
-//  Based on Thierry Koblentz's blog post on minimizing the already
-//  micro clearfix by Nicolas Gallagher.
-// ------------------------------------------------------------------- //
-
-@mixin clearfix {
-  &:after {
-    display: table;
-    clear: both;
-    content: "";
-  }
-}

data/app/assets/stylesheets/kentucky/addons/_easings.scss

@@ -1,37 +0,0 @@
-// ------------------------------------------------------------------- //
-//  Timing Functions
-//  
-//  Used for transitions / animations.
-//  
-//  Taken from http://easings.net/
-// ------------------------------------------------------------------- //
-
-// Ease In
-$ease-in-sine:  cubic-bezier(.47, 0, .745, .715);
-$ease-in-quad:  cubic-bezier(.55, .085, .68, .53);
-$ease-in-cubic: cubic-bezier(.55, .055, .675, .19);
-$ease-in-quart: cubic-bezier(.895, .03, .685, .22);
-$ease-in-quint: cubic-bezier(.755, .05, .855, .06);
-$ease-in-expo:  cubic-bezier(.95, .05, .795, .035);
-$ease-in-circ:  cubic-bezier(.6, .04, .98, .335);
-$ease-in-back:  cubic-bezier(.6, -.28, .735, .045);
-
-// Ease Out
-$ease-out-sine:  cubic-bezier(.39, .575, .565, 1);
-$ease-out-quad:  cubic-bezier(.25, .46, .45, .94);
-$ease-out-cubic: cubic-bezier(.215, .61, .355, 1);
-$ease-out-quart: cubic-bezier(.165, .84, .44, 1);
-$ease-out-quint: cubic-bezier(.23, 1, .32, 1);
-$ease-out-expo:  cubic-bezier(.19, 1, .22, 1);
-$ease-out-circ:  cubic-bezier(.075, .82, .165, 1);
-$ease-out-back:  cubic-bezier(.175, .885, .32, 1.275);
-
-// Ease In Out
-$ease-in-out-sine:  cubic-bezier(.445, .05, .55, .95);
-$ease-in-out-quad:  cubic-bezier(.455, .03, .515, .955);
-$ease-in-out-cubic: cubic-bezier(.645, .045, .355, 1);
-$ease-in-out-quart: cubic-bezier(.77, 0, .175, 1);
-$ease-in-out-quint: cubic-bezier(.86, 0, .07, 1);
-$ease-in-out-expo:  cubic-bezier(1, 0, 0, 1);
-$ease-in-out-circ:  cubic-bezier(.785, .135, .15, .86);
-$ease-in-out-back:  cubic-bezier(.68, -.55, .265, 1.55);