mifflin 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d15f9edc178e90bf9f9386a9d0788178e6489324
-  data.tar.gz: d11151ec2ceffc1d9ddce315d7f844e6b47def74
+  metadata.gz: a320de5ffcd3794447523d4a15191a04f800591d
+  data.tar.gz: f3ba7b13d47a8fde00cf8f7f6e678d26816bdfc0
 SHA512:
-  metadata.gz: c6a2bb911015904b87943199d1580a7492000a98116c2a61833df70997353305538c90be0e0d4e235e59a52ec55029e1d7d654820c70163763819729a02be302
-  data.tar.gz: c5413b2c0c725ac1df2f17d79c52e2f0d1552f34a4ae942c7a536830475ac38912e845c376d39d67ad7215f213bf954ec1f866d5ad341f26956f9eb55f2207b0
+  metadata.gz: ee15d19fc04f2a02094232949e8c3e4f00b34ebd06719b630e63aab50fe2210ec5d3f8ce2017d12e960a69f6a42e5f1a6ed2d7b294457d2b413d410f055b864b
+  data.tar.gz: 3c91b256fdee7be0e3cd4ba20dae7f3c3f3721c366e49ec00d98044b34acb87ae06bbc1a38a12605564a299b385a0d776e1a8e820de283a98c5d3e767a150a9e

data/.bowerrc

@@ -0,0 +1,3 @@
+{
+  "directory" : "vendor/assets/bower_components"
+}

data/README.md

@@ -1,8 +1,10 @@
 # Mifflin
 
-Mifflin is a template that uses all the modern tools to make front-end development easier. It includes several helpers, partials and a nice basic structure to the HTML, Sass and CoffeeScript.
+Mifflin provides to you all the modern tools that make front-end development easier. It organizes your Sass following [@csswizardry](https://github.com/csswizardry)'s [ITCSS](https://www.youtube.com/watch?v=1OKZOV-iLj4) and adds a little structure to your Coffescript files.
 
-It basically adds [Startaê's middleman template](http://github.com/startae/middleman-startae) assets into your Rails application.
+Mifflin provides all the packages you need from [inuit.css](https://github.com/inuitcss) under the hood and adds all the files you need to work on to make your app great.
+
+This project is pretty similar to [Startaê's middleman template](http://github.com/startae/middleman-startae), the idea is to make the template we use for Middleman projects available to Rails projects.
 
 ## Installation
 
@@ -22,7 +24,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After installing the gem, you need to run the generator.
+
+**ATTENTION: The generator will delete your `application.css` and your `application.js` files. For now, mifflin is only recommended for new projects.**
+
+    $ rails generate mifflin:install
+
+    remove  app/assets/stylesheets/application.css
+    create  app/assets/stylesheets/application.css.sass
+    create  app/assets/stylesheets/_requirements.sass
+    create  app/assets/stylesheets/settings
+    create  app/assets/stylesheets/settings/_settings.global.sass
+    create  app/assets/stylesheets/settings/_settings.fonts.sass
+    create  app/assets/stylesheets/settings/_settings.colors.sass
+    create  app/assets/stylesheets/settings/_settings.grid.sass
+    create  app/assets/stylesheets/tools
+    create  app/assets/stylesheets/tools/_tools.mixins.sass
+    create  app/assets/stylesheets/tools/_tools.mediaqueries.sass
+    create  app/assets/stylesheets/tools/_tools.intrinsic-ratio.sass
+    create  app/assets/stylesheets/generic
+    create  app/assets/stylesheets/generic/_generic.example.sass
+    create  app/assets/stylesheets/base
+    create  app/assets/stylesheets/base/_base.page.sass
+    create  app/assets/stylesheets/base/_base.type.sass
+    create  app/assets/stylesheets/objects
+    create  app/assets/stylesheets/objects/_objects.containers.sass
+    create  app/assets/stylesheets/components
+    create  app/assets/stylesheets/components/_components.buttons.sass
+    create  app/assets/stylesheets/trumps
+    create  app/assets/stylesheets/trumps/_trumps.example.sass
+    remove  app/assets/javascripts/application.js
+    create  app/assets/javascripts/application.js.coffee
+    create  app/assets/javascripts/requirements.js.coffee
 
 ## Development
 

data/bower.json

@@ -0,0 +1,34 @@
+{
+  "name": "mifflin",
+  "version": "0.0.0",
+  "private": "true",
+  "authors": [
+    "Rômulo Machado <http://romulomachado.github.io>"
+  ],
+  "dependencies": {
+    "bourbon": "~4.2.3",
+    "susy": "~2.2.5",
+    "fastclick": "~1.0.6",
+    "enquire": "~2.1.2",
+    "picturefill": "~3.0.0-alpha1",
+    "inuit-defaults": "0.2.3",
+    "inuit-functions": "0.2.0",
+    "inuit-mixins": "0.2.3",
+    "inuit-box-sizing": "0.2.0",
+    "inuit-normalize": "3.0.3",
+    "inuit-page": "0.2.1",
+    "inuit-shared": "~0.1.5",
+    "inuit-reset": "~0.1.1",
+    "inuit-buttons": "~0.4.2",
+    "inuit-list-block": "~0.4.2",
+    "inuit-list-bare": "~0.3.0",
+    "inuit-list-ui": "~0.4.1",
+    "inuit-media": "~0.4.2",
+    "inuit-clearfix": "~0.2.2",
+    "inuit-lists": "~0.1.0",
+    "inuit-images": "~0.3.3",
+    "inuit-spacing": "~0.7.0",
+    "inuit-flag": "~0.3.2",
+    "inuit-list-inline": "~0.3.2"
+  }
+}

data/lib/generators/mifflin/install/install_generator.rb

@@ -0,0 +1,88 @@
+require 'rails/generators'
+
+module Mifflin
+  module Generators
+    class Mifflin::InstallGenerator < Rails::Generators::Base
+      desc "Installs Mifflin and generates the necessary files"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def setup_stylesheets
+        copy_application_sass
+        copy_requirements_sass
+        copy_settings_styles
+        copy_tools_styles
+        copy_generic_styles
+        copy_base_styles
+        copy_objects_styles
+        copy_components_styles
+        copy_trumps_styles
+      end
+
+      def setup_js
+        copy_application_coffee
+        copy_requirements_coffee
+      end
+
+      private
+        def copy_application_sass
+          remove_file 'app/assets/stylesheets/application.css'
+          template 'assets/stylesheets/application.css.sass', 'app/assets/stylesheets/application.css.sass'
+        end
+
+        def copy_requirements_sass
+          template 'assets/stylesheets/requirements.sass', 'app/assets/stylesheets/_requirements.sass'
+        end
+
+        def copy_settings_styles
+          empty_directory 'app/assets/stylesheets/settings'
+          template 'assets/stylesheets/settings/_settings.global.sass', 'app/assets/stylesheets/settings/_settings.global.sass'
+          template 'assets/stylesheets/settings/_settings.fonts.sass', 'app/assets/stylesheets/settings/_settings.fonts.sass'
+          template 'assets/stylesheets/settings/_settings.colors.sass', 'app/assets/stylesheets/settings/_settings.colors.sass'
+          template 'assets/stylesheets/settings/_settings.grid.sass', 'app/assets/stylesheets/settings/_settings.grid.sass'
+        end
+
+        def copy_tools_styles
+          empty_directory 'app/assets/stylesheets/tools'
+          template 'assets/stylesheets/tools/_tools.mixins.sass', 'app/assets/stylesheets/tools/_tools.mixins.sass'
+          template 'assets/stylesheets/tools/_tools.mediaqueries.sass', 'app/assets/stylesheets/tools/_tools.mediaqueries.sass'
+          template 'assets/stylesheets/tools/_tools.intrinsic-ratio.sass', 'app/assets/stylesheets/tools/_tools.intrinsic-ratio.sass'
+        end
+
+        def copy_generic_styles
+          empty_directory 'app/assets/stylesheets/generic'
+          template 'assets/stylesheets/generic/_generic.example.sass', 'app/assets/stylesheets/generic/_generic.example.sass'
+        end
+
+        def copy_base_styles
+          empty_directory 'app/assets/stylesheets/base'
+          template 'assets/stylesheets/base/_base.page.sass', 'app/assets/stylesheets/base/_base.page.sass'
+          template 'assets/stylesheets/base/_base.type.sass', 'app/assets/stylesheets/base/_base.type.sass'
+        end
+
+        def copy_objects_styles
+          empty_directory 'app/assets/stylesheets/objects'
+          template 'assets/stylesheets/objects/_objects.containers.sass', 'app/assets/stylesheets/objects/_objects.containers.sass'
+        end
+
+        def copy_components_styles
+          empty_directory 'app/assets/stylesheets/components'
+          template 'assets/stylesheets/components/_components.buttons.sass', 'app/assets/stylesheets/components/_components.buttons.sass'
+        end
+
+        def copy_trumps_styles
+          empty_directory 'app/assets/stylesheets/trumps'
+          template 'assets/stylesheets/trumps/_trumps.example.sass', 'app/assets/stylesheets/trumps/_trumps.example.sass'
+        end
+
+        def copy_application_coffee
+          remove_file 'app/assets/javascripts/application.js'
+          template 'assets/javascripts/application.js.coffee', 'app/assets/javascripts/application.js.coffee'
+        end
+
+        def copy_requirements_coffee
+          template 'assets/javascripts/requirements.js.coffee', 'app/assets/javascripts/requirements.js.coffee'
+        end
+    end
+  end
+end

data/lib/generators/mifflin/install/templates/assets/javascripts/application.js.coffee

@@ -0,0 +1,9 @@
+# *************************************
+#
+#   Application
+#
+# *************************************
+
+# -------------------------------------
+#   Components
+# -------------------------------------

data/lib/generators/mifflin/install/templates/assets/javascripts/requirements.js.coffee

@@ -0,0 +1,5 @@
+# ******************************************************************
+#
+#   #requirements
+#
+# ******************************************************************

data/lib/generators/mifflin/install/templates/assets/stylesheets/application.css.sass

@@ -0,0 +1,80 @@
+@charset "utf-8"
+// --------------------------------------
+//
+//  APPLICATION
+//
+// --------------------------------------
+
+
+// 0. Requirements -- Vendor libraries
+// 1. Settings ------ Sass vars, etc.
+// 2. Tools --------- Functions and mixins.
+// 3. Generic ------- Generic, high-level styling, like resets, etc.
+// 4. Base ---------- Unclasses HTML elements (e.g. `h2`, `ul`).
+// 5. Objects ------- Objects and abstractions.
+// 6. Components ---- Your designed UI elements (inuitcss includes none of these).
+// 7. Trumps -------- Overrides and helper classes.
+
+
+// [0] Requirements
+@import "requirements"
+
+
+// [1] Settings
+@import "inuit-defaults/settings.defaults"
+@import "settings/settings.global"
+@import "settings/settings.fonts"
+@import "settings/settings.colors"
+@import "settings/settings.grid"
+
+
+// [2] Tools
+@import "inuit-functions/tools.functions"
+@import "inuit-mixins/tools.mixins"
+@import "tools/tools.mixins"
+@import "tools/tools.mediaqueries"
+@import "tools/tools.intrinsic-ratio"
+
+
+// [3] Generic
+@import "inuit-normalize/generic.normalize"
+@import "inuit-box-sizing/generic.box-sizing"
+@import "inuit-reset/generic.reset"
+@import "inuit-shared/generic.shared"
+
+
+// [4] Base
+@import "inuit-page/base.page"
+@import "inuit-lists/base.lists"
+@import "inuit-images/base.images"
+@import "base/base.page"
+@import "base/base.type"
+
+
+// [5] Objects
+$inuit-btn-radius:        $base-radius
+$inuit-enable-btn--small: true
+$inuit-enable-btn--large: true
+$inuit-enable-btn--full:  true
+@import "inuit-buttons/objects.buttons"
+@import "inuit-list-bare/objects.list-bare"
+@import "inuit-list-block/objects.list-block"
+@import "inuit-list-inline/objects.list-inline"
+@import "inuit-list-ui/objects.list-ui"
+@import "inuit-media/objects.media"
+@import "inuit-flag/objects.flag"
+@import "objects/objects.containers"
+
+
+// [6] Components
+@import "components/components.buttons"
+// >>> Your components here <<<
+
+
+// [7] Trumps
+@import "inuit-clearfix/trumps.clearfix"
+
+$inuit-enable-margins:       true
+$inuit-enable-margins--huge: true
+$inuit-enable-margins--none: true
+@import "inuit-spacing/trumps.spacing"

data/lib/generators/mifflin/install/templates/assets/stylesheets/base/_base.page.sass

@@ -0,0 +1,9 @@
+// --------------------------------------
+//
+//   #base.page
+//
+// --------------------------------------
+
+
+html
+  font-family: $sans-serif

data/lib/generators/mifflin/install/templates/assets/stylesheets/base/_base.type.sass

@@ -0,0 +1,68 @@
+// --------------------------------------
+//
+//   #base.type
+//   Typographical base selectors.
+//
+// --------------------------------------
+
+
+// Headings 1–6.
++headings()
+  +font-weight(bold)
+  color: $color-headings
+
+
+// A generic heading style which can be applied to any headings.
+.heading
+  +inuit-font-size(22px)
+
+.heading-sub
+  +inuit-font-size(16px)
+  +font-weight(bold)
+  margin-bottom: 0
+  color: $color-heading-sub
+
+
+// Emboldened elements.
+a,
+strong, b,
+dt
+  +font-weight(bold)
+
+
+// Code-like elements.
+code, kbd, samp
+  color: $color-code
+  font-family: $monospace
+
+pre
+  white-space: pre
+  word-wrap: normal
+  overflow: auto
+  padding: $inuit-base-spacing-unit--small
+  background-color: $color-pre-background
+  border-radius: $base-radius
+
+  &,
+  code, kbd, samp
+    color: $color-pre
+
+
+// Horizontal rules.
+hr
+  border: none
+  border-bottom: 1px solid $color-gray-ui
+  margin-bottom: $inuit-base-spacing-unit - 1px
+
+
+// Highlighted text.
+mark
+  pre &
+    background: none
+    border-bottom: 1px solid
+    color: inherit
+
+
+// Text-alignment.
+.text-banner
+  text-align: center

data/lib/generators/mifflin/install/templates/assets/stylesheets/components/_components.buttons.sass

@@ -0,0 +1,23 @@
+// --------------------------------------
+//
+//   #components.buttons
+//
+// --------------------------------------
+
+
+.btn
+  +font-weight(bold)
+  +transition(all 0.2s)
+
+  +attention()
+    background-color: darken($color-btn, 10%)
+    border-color: darken($color-btn, 10%)
+
+
+.btn--secondary
+  background: none
+  color: $color-btn
+
+  +attention()
+    background: none
+    color: darken($color-btn, 10%)

data/lib/generators/mifflin/install/templates/assets/stylesheets/objects/_objects.containers.sass

@@ -0,0 +1,9 @@
+// --------------------------------------
+//
+//   #objects.containers
+//   Width-limiting blocks
+//
+// --------------------------------------
+
+.container
+  +container

data/lib/generators/mifflin/install/templates/assets/stylesheets/requirements.sass

@@ -0,0 +1,20 @@
+// --------------------------------------
+//
+//   #requirements
+//
+// --------------------------------------
+
+// -------------------------------------
+//   Bourbon - bourbon.io
+// -------------------------------------
+@import "bourbon/app/assets/stylesheets/bourbon"
+$prefix-for-webkit: false
+$prefix-for-mozilla: false
+$prefix-for-microsoft: false
+$prefix-for-opera: false
+$prefix-for-spec: true
+
+// -------------------------------------
+//   Susy - susy.oddbird.net
+// -------------------------------------
+@import "susy/sass/susy"

data/lib/generators/mifflin/install/templates/assets/stylesheets/settings/_settings.colors.sass

@@ -0,0 +1,59 @@
+// --------------------------------------
+//
+//   #settings.colors
+//
+// --------------------------------------
+
+
+$color-brand:      #000
+$color-gray-light: #999
+$color-gray:       #666
+$color-gray-dark:  #212121
+$color-gray-ui:    #ddd
+$color-pink:       #ff0069
+$color-blue:       #008cdd
+$color-green:      #64bd2e
+$color-highlight:  #fff
+$color-tint:       #f2f2f2
+$color-positive:   #64bd2e
+$color-negative:   #ff7076
+
+
+// Page
+$inuit-base-background-color: #fff
+$inuit-base-text-color:       $color-gray-dark
+
+
+// Links
+$color-links:          $color-blue
+$color-links-carousel: $color-gray-ui
+
+
+// Text
+$color-code:           $color-green
+$color-pre-background: $color-gray
+$color-pre:            #fff
+
+
+// Headings
+$color-headings:    $color-gray-dark
+$color-heading-sub: $color-gray
+
+
+// Buttons
+$color-btn: $color-links
+
+
+// Page head
+$color-masthead:             #fff
+$color-page-head-border:     $color-pink
+$color-page-head:            #fff
+$color-page-head-background: #fff
+
+
+// Site nav
+$color-site-nav: $inuit-base-text-color
+
+
+// Page foot
+$color-page-foot: #fff