neat 1.7.0 → 4.0.0

data/core/neat/mixins/_grid-visual.scss

@@ -0,0 +1,41 @@
+@charset "UTF-8";
+/// Creates a series of guide lines using the `background-image` property on a
+/// grid container to visualise the columns and gutters of the grid.
+///
+/// @group features
+///
+/// @name Grid visual
+///
+/// @argument {color} $color
+///   The color of the guide lines created.
+///
+/// @argument {map} $grid [$neat-grid]
+///   The grid used to determine the guides
+///
+/// @example scss
+///   .element {
+///     @include grid-visual;
+///   }
+///
+/// @example css
+///   .element {
+///     background-image: repeating-linear-gradient( … ) ;
+///   }
+
+@mixin grid-visual($color: null, $grid: $neat-grid) {
+  @if not $color {
+    $color: _retrieve-neat-setting($grid, color);
+  }
+
+  $_grid-columns: _retrieve-neat-setting($grid, columns);
+  $_grid-gutter: _retrieve-neat-setting($grid, gutter);
+  $_grid-visual-column: "#{_neat-column-width($grid, 1)} + #{$_grid-gutter}";
+  $_grid-visual:
+    transparent,
+    transparent $_grid-gutter,
+    $color $_grid-gutter,
+    $color calc(#{$_grid-visual-column}),
+  ;
+
+  background-image: repeating-linear-gradient(to right, $_grid-visual);
+}

data/core/neat/settings/_settings.scss

@@ -0,0 +1,74 @@
+@charset "UTF-8";
+/// This variable is a sass map that overrides Neat's default grid settings.
+/// Use this to define your project's grid properties including gutters and
+/// total column count.
+///
+/// @type map
+///
+/// @group settings
+///
+/// @name Neat grid
+///
+/// @property {number (unitless)} columns [12]
+///   Default number of the total grid columns.
+///
+/// @property {number (with unit)} gutter [20px]
+///   Default grid gutter width between columns.
+///
+/// @example scss
+///   $neat-grid: (
+///     columns: 12,
+///     gutter: 20px,
+///   );
+
+$neat-grid: () !default;
+
+/// If you need multiple grids in a single project, you can do
+/// this by defining a new map stored within a variable of your choosing. This
+/// variable can then be passed directly in to any of Neat's mixins like
+/// [`grid-column(12, $my-custom-grid)`](#grid-column).
+///
+/// Custom grids are especially useful with [`grid-media`](#grid-media). By
+/// defining a `media` attribute within your custom grid, you are able to easily
+/// define gutter width and total column count as well the breakpoint at which
+/// they should activate.
+///
+/// @type map
+///
+/// @group settings
+///
+/// @name Custom grids
+///
+/// @property {number (unitless)} columns [12]
+///   Number of the total grid columns.
+///
+/// @property {number (with unit)} gutter [20px]
+///   Grid gutter width between columns.
+///
+/// @property {number (with unit) | string | null} media [null]
+///   The `@media` definition that is used by the [`grid-media`](#grid-media)
+///   mixin to determine the media properties.
+///
+/// @property {color} color [null]
+///   The color used by [`grid-visual`](#grid-visual) to create the guides.
+///
+/// @property {string} direction [ltr]
+///   The float direction used throughout the grid.
+///
+/// @example scss
+///   $my-custom-grid: (
+///     columns: 12,
+///     gutter: 20px,
+///     media: 1200px,
+///     color: rgba(#00d4ff, 0.25),
+///     direction: ltr,
+///   );
+///
+///   $other-custom-grid-for-print: (
+///     columns: 14,
+///     gutter: 1.5rem,
+///     media: print,
+///   );
+///
+
+$neat-custom-grid: () !default;

data/eyeglass-exports.js

@@ -0,0 +1,7 @@
+var neat = require("./index");
+
+module.exports = function(eyeglass, sass) {
+  return {
+    sassDir: neat.includePaths[0]
+  };
+};

data/index.js

@@ -0,0 +1,7 @@
+var path = require("path");
+
+module.exports = {
+  includePaths: [
+    path.join(__dirname, "core")
+  ]
+};

data/lib/neat/generator.rb

@@ -1,21 +1,24 @@
+require "neat/version"
 require "fileutils"
+require "thor"
 
 module Neat
-  class Generator
-    def initialize(arguments)
-      @subcommand = arguments.first
-    end
+  class Generator < Thor
+    map ["-v", "--version"] => :version
 
-    def run
-      if @subcommand == "install"
-       install
-      elsif @subcommand == "update"
-        update
-      elsif @subcommand == "remove"
-        remove
+    desc "install", "Install Neat into your project"
+    method_options path: :string, force: :boolean
+    def install
+      if neat_files_already_exist? && !options[:force]
+        puts "Neat files already installed, doing nothing."
+      else
+        install_files
+        puts "Neat files installed to #{install_path}/"
       end
     end
 
+    desc "update", "Update Neat"
+    method_options path: :string
     def update
       if neat_files_already_exist?
         remove_neat_directory
@@ -26,15 +29,8 @@ module Neat
       end
     end
 
-    def install
-      if neat_files_already_exist?
-        puts "Neat files already installed, doing nothing."
-      else
-        install_files
-        puts "Neat files installed to neat/"
-      end
-    end
-
+    desc "remove", "Remove Neat"
+    method_options path: :string
     def remove
       if neat_files_already_exist?
         remove_neat_directory
@@ -44,19 +40,40 @@ module Neat
       end
     end
 
+    desc "version", "Show Neat version"
+    def version
+      say "Neat #{Neat::VERSION}"
+    end
+
     private
 
     def neat_files_already_exist?
-      File.directory?("neat")
+      install_path.exist?
     end
 
-    def install_files
-      FileUtils.mkdir_p("neat")
-      FileUtils.cp_r(all_stylesheets, "neat/")
+    def install_path
+      @install_path ||= if options[:path]
+          Pathname.new(File.join(options[:path], "neat"))
+        else
+          Pathname.new("neat")
+        end
     end
 
     def remove_neat_directory
-      FileUtils.rm_rf("neat")
+      FileUtils.rm_rf(install_path)
+    end
+
+    def install_files
+      make_install_directory
+      copy_in_scss_files
+    end
+
+    def make_install_directory
+      FileUtils.mkdir_p(install_path)
+    end
+
+    def copy_in_scss_files
+      FileUtils.cp_r(all_stylesheets, install_path)
     end
 
     def all_stylesheets
@@ -64,7 +81,7 @@ module Neat
     end
 
     def stylesheets_directory
-      File.join(top_level_directory, "app", "assets", "stylesheets")
+      File.join(top_level_directory, "core")
     end
 
     def top_level_directory

data/lib/neat/version.rb

@@ -1,3 +1,3 @@
 module Neat
-  VERSION = '1.7.0'
+  VERSION = "4.0.0"
 end

data/lib/neat.rb

@@ -1,20 +1,15 @@
-require "bourbon"
 require "neat/generator"
 
 module Neat
   if defined?(Rails) && defined?(Rails::Engine)
     class Engine < ::Rails::Engine
-      require 'neat/engine'
-    end
-
-    module Rails
-      class Railtie < ::Rails::Railtie
-        rake_tasks do
-          load "tasks/install.rake"
-        end
-      end
+      config.assets.paths << File.expand_path("../core", __dir__)
     end
   else
-    Sass.load_paths << File.expand_path("../../app/assets/stylesheets", __FILE__)
+    begin
+      require "sass"
+      Sass.load_paths << File.expand_path("../core", __dir__)
+    rescue LoadError
+    end
   end
 end

data/neat.gemspec

@@ -1,35 +1,30 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require 'neat/version'
+$:.push File.expand_path("../lib", __FILE__)
+require "neat/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'neat'
-  s.version     = Neat::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Kyle Fiedler', 'Reda Lemeden', 'Joel Oliveira']
-  s.email       = ['support@thoughtbot.com']
-  s.homepage    = 'https://github.com/thoughtbot/neat'
-  s.summary     = 'A fluid grid framework on top of Bourbon'
-  s.license     = 'MIT'
-  s.description = <<-DESC
-Neat is an open source grid framework built on top of Bourbon with the aim of being easy enough to use out of the box and flexible enough to customize down the road.
-  DESC
-
-  s.rubyforge_project = 'neat'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.add_development_dependency "aruba", "~> 0.5.0"
+  s.add_development_dependency "css_parser"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "scss_lint", "~> 0.44"
+  s.add_runtime_dependency "thor", "~> 0.19"
+  s.authors = [
+    "Joel Oliveira",
+    "Joshua Ogle",
+    "Kyle Fiedler",
+    "Reda Lemeden",
+    "Tyson Gach",
+    "Ward Penney",
+    "Will McMahan"
+  ]
+  s.email         = "design+neat@thoughtbot.com"
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
-
-  s.add_dependency('sass', '>= 3.3')
-  s.add_dependency('bourbon', '>= 4.0')
-
-  s.add_development_dependency('aruba', '~> 0.5.0')
-  s.add_development_dependency('rake')
-  s.add_development_dependency('css_parser')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('rdoc')
-  s.add_development_dependency('bundler')
-  s.add_development_dependency('rb-fsevent', '~> 0.9.1')
+  s.files         = `git ls-files`.split("\n")
+  s.homepage      = "http://neat.bourbon.io"
+  s.license       = "MIT"
+  s.name          = "neat"
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ["lib"]
+  s.summary       = "A lightweight Sass grid framework"
+  s.version       = Neat::VERSION
 end