atomic_sass 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15d11fa9c28df308ffe4ea33f3cb579063b2e7f1
-  data.tar.gz: 9fa8136b2f4a7a5226583ce078a5ccb544156ef8
+  metadata.gz: 359cd22f219b0555718424532f55ffd2a14cb5a7
+  data.tar.gz: b74f06af7c898384b90c901fc5a67dc405a68418
 SHA512:
-  metadata.gz: f73fb7df6fe5ec8a12bb66beacb911b52cfcd9a3a80b4efc94edf256580bcc26ba470d520f521ebeeb3c5b00a202e8adc7b58e4e46024f63a45be3a334b639b5
-  data.tar.gz: 3647c5f14d63ecae2a2d384282563ec159cfccee63c7c545a27b6d4e8708cd53b8ca99c635de2b06e6e4c936484c9fdfc0e05fb960ac9a629488d1455e7c88b9
+  metadata.gz: 98089e94bf3543085a74e0504a580bdfc4b140c78a7a48b88f4b2deacd1d266a7a96476c3ae8685279deb67579eac1e01496499cdbe95a36ba1db788e91f552f
+  data.tar.gz: 6b5bf3361b8cacf945c596fa2c8655c995d109dbfdbc7eb9b395a48b009b8333c6f7465990558f81cdb315bb2750e530d8d4b12e5badfc9bb40d4538725e2b75

data/README.md

@@ -2,6 +2,7 @@
 
 Generators that make [atomic design](http://coding.smashingmagazine.com/2013/08/02/other-interface-atomic-design-sass/) with SASS easy.
 
+![](http://f.cl.ly/items/0T1v2y3z330O2i2L2M0v/out_gif.gif)
 
 ## Installation
 
@@ -17,11 +18,24 @@ Initialize your project
 atom init
 ```
 
-##### Generate your documents by passing the appropriate flag then an array of new document names
+This creates a yaml file where you can specify:
+- the source directory 
+- the destination directory
+- your preferred sass syntax (scss or sass)
 
-- quark `atom g -q header nav footer aside`
-- utility `atom g -u clearfix`
-- atom `atom g -a input button`
+After the settings are set the way you like you can build the initial file structure with
+
+```bash
+atom build
+```
+
+Now you are ready to start styling.
+
+Generate your documents by passing the appropriate flag then an array of new document names
+
+- quark `atom generate --quark header nav footer aside`
+- utility `atom generate -u clearfix`
+- atom `atom g --atom input button`
 - molecules `atom g -m seachbar top_nav`
 
 or a few at once
@@ -29,20 +43,31 @@ or a few at once
 atom g -a input button -q header nav footer -m seachbar top_nav
 ```
 
-##### specify which molecules will use your atom at generation
+specify which molecules will use your atom at generation
 ( -i is short for --include )
 ```bash
 atom g -a input button -i seachbar
 ```
 
-##### or include some atoms in a quark (or quarks)
+or include some atoms in a quark (or quarks)
 ```bash
 atom g -q header
 atom g -a text_shadow --include-quark header
 ```
 
-##### nested routes are automatically resolved too, so nest all you like
+nested routes are automatically resolved too, so nest all you like
 ```bash
 atom g -m header/searchbar
 atom g -a typography/textfields/input -i header/searchbar
 ```
+
+
+Compile to css with
+```bash 
+atom compile
+```
+
+or compile and watch for changes with
+```bash
+atom compile --watch
+```

data/lib/atomic_sass.rb

@@ -1,16 +1,23 @@
 require "atomic_sass/version"
+require "atomic_sass/settings"
 require 'active_support/core_ext/string/inflections'
 require 'sass'
 require 'sass/exec'
 require 'thor'
+require 'yaml'
 
 module AtomicSass
   class SassGenerator < Thor
     map 'g' => :generate
     include Thor::Actions
 
-    desc 'init', 'Create base structure for atomic sass'
+    desc 'init', 'Render settings file'
     def init
+      template('settings.tt', '.atomic_sass.yml')
+    end
+
+    desc 'build', 'Generate base structure for atomic sass'
+    def build
       build_base_structure
     end
 
@@ -22,19 +29,19 @@ module AtomicSass
     def generate
       _only_file_options.each do |key, values|
         values.each do |value|
-          file_path, enclosing_dirs = _extract_and_create_dirs(value, "sass/#{key.pluralize}")
-          create_sass_doc("sass/#{key.pluralize}/#{enclosing_dirs}_#{file_path}.sass", key)
+          file_path, enclosing_dirs = _extract_and_create_dirs(value, "#{settings.source_dir}/#{key.pluralize}")
+          create_sass_doc("#{settings.source_dir}/#{key.pluralize}/#{enclosing_dirs}_#{file_path}", key)
         end
         append_to_manifest(key, values)
       end
       _include_atoms(_only_include_options, options[:atom]) if _only_include_options && options[:atom]
     end
 
-    desc 'build', 'Compile the sass to css'
+    desc 'compile', 'Compile the sass to css'
     method_option :watch, type: :boolean, aliases: %W[ -w ]
-    def build
+    def compile
       if options[:watch]
-        _compile_and_watch_sass
+        _compile_sass(true)
       else
         _compile_sass
       end
@@ -42,21 +49,27 @@ module AtomicSass
 
     no_commands do
 
+      def settings
+        @settings ||= AtomicSass::Settings.new
+      end
+
       def create_sass_doc(path, key)
+        ext = settings.sass_syntax
         if not key.match /molecule|quark/
-          create_file(path)
+          create_file("#{path}.#{ext}")
         else
-          create_file(path) do
+          create_file("#{path}.#{ext}") do
             ["//--- BEGIN IMPORTS", "//--- END IMPORTS", "\n"].join("\n")
           end
         end
       end
 
       def append_to_manifest(manifest_type, generated_filenames)
+        ext = settings.sass_syntax
         unless manifest_type == 'atom'
-          inject_into_file("sass/#{manifest_type.pluralize}/#{manifest_type}_manifest.sass", before: "\n//--- END IMPORTS") do
+          inject_into_file("#{settings.source_dir}/#{manifest_type.pluralize}/#{manifest_type}_manifest.#{ext}", before: "\n//--- END IMPORTS") do
             generated_filenames.map do |filename|
-              "@import #{filename}"
+              _sass_import(filename)
             end.join("\n").prepend("\n")
           end
         end
@@ -65,41 +78,36 @@ module AtomicSass
       def build_base_structure
         entries = %w[ utility quark molecule atom ]
         manifest_entries = entries.reject { |e| e == 'atom' }
-        empty_directory('sass')
-        empty_directory('css')
+        empty_directory(settings.source_dir)
+        empty_directory(settings.dest_dir)
         _build_application_sass(manifest_entries)
         _build_empty_dirs(entries)
         _build_manifest_entries(manifest_entries)
       end
 
-      def _compile_sass
-        if ::Sass::Exec::Sass.new(%w[ sass/application.sass:css/application.css ]).parse
-          puts "Successfully built application.css"
+      def _compile_sass(watch = false)
+        ext = settings.sass_syntax
+        if ext == 'sass'
+          ::Sass::Exec::Sass.new(%W[ #{settings.source_dir}/application.#{ext}:#{settings.dest_dir}/application.css ]).parse
+          ::Sass::Exec::Sass.new(%W[ #{settings.source_dir}/application.#{ext}:#{settings.dest_dir}/application.css ]).parse if watch
         else
-          puts "Failed to build sass"
-        end
-      end
-
-
-      def _compile_and_watch_sass
-        _compile_sass
-        puts "Watching for changes to application.sass"
-        unless ::Sass::Exec::Sass.new(%w[ --watch sass/application.sass:css/application.css ]).parse
-          puts "Failed to watch sass"
+          ::Sass::Exec::Scss.new(%W[ #{settings.source_dir}/application.#{ext}:#{settings.dest_dir}/application.css ]).parse
+          ::Sass::Exec::Scss.new(%W[ #{settings.source_dir}/application.#{ext}:#{settings.dest_dir}/application.css ]).parse if watch
         end
       end
 
       def _build_application_sass(entries)
-        create_file("sass/application.sass") do
+        ext = settings.sass_syntax
+        create_file("#{settings.source_dir}/application.#{ext}") do
           entries.map do |entry|
-            "@import #{entry.pluralize}/#{entry}_manifest"
+            _sass_import("#{entry.pluralize}/#{entry}_manifest")
           end.join("\n")
         end
       end
 
       def _build_empty_dirs(entries)
         entries.each do |entry|
-          empty_directory("sass/#{entry.pluralize}")
+          empty_directory("#{settings.source_dir}/#{entry.pluralize}")
         end
       end
 
@@ -110,8 +118,9 @@ module AtomicSass
       end
 
       def _build_manifest_entries(entries)
+        ext = settings.sass_syntax
         entries.each do |entry|
-          template("#{entry}_manifest.tt", "sass/#{entry.pluralize}/#{entry}_manifest.sass")
+          template("#{entry}_manifest.tt", "#{settings.source_dir}/#{entry.pluralize}/#{entry}_manifest.#{ext}")
         end
       end
 
@@ -125,18 +134,27 @@ module AtomicSass
       end
 
       def _include_atoms(include_types, atoms)
+        ext = settings.sass_syntax
         include_types.each do |type, filenames|
           filenames.each do |filename|
-            file_path, enclosing_dirs = _extract_and_create_dirs(filename, "sass/#{type.pluralize}")
-            inject_into_file("sass/#{type.pluralize}/#{enclosing_dirs}_#{file_path}.sass", before: "\n//--- END IMPORTS") do
+            file_path, enclosing_dirs = _extract_and_create_dirs(filename, "#{settings.source_dir}/#{type.pluralize}")
+            inject_into_file("#{settings.source_dir}/#{type.pluralize}/#{enclosing_dirs}_#{file_path}.#{ext}", before: "\n//--- END IMPORTS") do
               atoms.map do |atom|
-                "@import ../#{_escape_file_path(enclosing_dirs)}atoms/#{atom}"
+                _sass_import("../#{_escape_file_path(enclosing_dirs)}atoms/#{atom}")
               end.join("\n").prepend("\n")
             end
           end
         end
       end
 
+      def _sass_import(file_path)
+        if settings.sass_syntax == 'sass'
+          return "@import #{file_path}"
+        else
+          return "@import \"#{file_path}\";"
+        end
+      end
+
       def _only_file_options
         options.reject { |key, value| key.match /include/ }
       end

data/lib/atomic_sass/settings.rb

@@ -0,0 +1,26 @@
+module AtomicSass
+  class Settings
+    attr_reader :settings
+
+    def initialize
+      @settings = YAML.load_file('.atomic_sass.yml')
+    end
+
+    def source_dir
+      @settings['source_dir'] || 'sass'
+    end
+
+    def dest_dir
+      @settings['dest_dir'] || 'css'
+    end
+
+    def sass_syntax
+      if @settings['sass_syntax']
+        raise "invalid sass syntax specified" unless @settings['sass_syntax'].match /scss|sass/
+        return @settings['sass_syntax']
+      else
+        return 'sass'
+      end
+    end
+  end
+end

data/lib/atomic_sass/templates/settings.tt

@@ -0,0 +1,3 @@
+source_dir: 'sass'
+dest_dir: 'css'
+sass_syntax: 'sass'

data/lib/atomic_sass/version.rb

@@ -1,3 +1,3 @@
 module AtomicSass
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atomic_sass
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Travis Staton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -96,8 +96,10 @@ files:
 - atomic_sass.gemspec
 - bin/atom
 - lib/atomic_sass.rb
+- lib/atomic_sass/settings.rb
 - lib/atomic_sass/templates/molecule_manifest.tt
 - lib/atomic_sass/templates/quark_manifest.tt
+- lib/atomic_sass/templates/settings.tt
 - lib/atomic_sass/templates/utility_manifest.tt
 - lib/atomic_sass/version.rb
 homepage: ''