tsscssd 0.0.2 → 0.0.3

data/README.md

@@ -1,8 +1,28 @@
 # Tsscssd
+***
 
-TODO: Write a gem description
+Mo' CSS, no problems! Introducing Tyler's Stupid Simple Cascading Style Sheet Deco-dementor ©
 
-## Installation
+***
+
+
+## What is this shit?
+
+The TSSCSSD--sometimes pronounced "T two S C two S D" depending on level of G-ness--is a simple
+CSS comment parser. Ta-da!
+
+Having gotten fed up with overly complex solutions, I decided to write my own. KSS sucks and
+CSS_Doc is BROKEN.
+
+Besides, both were too heavy for my simple use case of "Hey man, I just wanna print my
+comments out in an easy to reference style guide that is both easy on my eyes and wallet." Sub
+in "sanity" for "wallet" because time is money and I have money on my mind.
+
+The TSSCSSD will take your lame ass CSS comments, bust that shit out of their code chains, and
+lay out fat stacks of tabular goodness for you all to party in. Or...lay out fat stacks of
+tabular goodness in which for all you to part-ay.
+
+## How do I get started with this shit?
 
 Add this line to your application's Gemfile:
 
@@ -16,14 +36,83 @@ Or install it yourself as:
 
     $ gem install tsscssd
 
-## Usage
+## How do I prep this shit?
+
+*8Get crackin' on your CSS, homie!
+
+Once you have shit handled--like HANDLED--you just need to throw down with this at the top of
+your code:
+
+    /*
+    * Key        - Value
+    */
+
+You can slap as many silly ass key/value pairs as your little heart desires. A best practice
+would be something like this shit:
+
+    /*
+    * Name          - THE Shit
+    * Author        - <a href="mailto:lilweezy@youngmoney.biz">Mr. Wayne</a>
+    * Description   - This file is full of cash money.
+    */
+
+In addition to your own silly ass key/value pairs, you get and additional couple *FOR FREE*!
+These freebies are Filename (the file name...) and Dependencies (for all you mixin-ers).
+
+Now, anything you want to have pulled out into the complimentary style guide, just comment
+*directly* above the selector with a // <SPACE> to have that shit Fire in the Skied all up into
+the mothership.
+
+So like this:
+
+    // This is pretty much the dopest siz-lector.
+    .sizlector.the.bomb
+
+###LISTEN
+
+Every file you want to have not-jacked-up style documentation has to start with this
+otherwise the docu-dementor will not correctly disturb your shit and will literally 
+puke all over your shit.
+
+###IF YOU DON'T WANT SHIT DOCU-DEMENTED
+
+That's just silly. But, for things you want skipped, add the file name to the skip array
+in the command (see below for mo' info).
+
+*Nuff said.*
+
+When he goes for his walk of assets/stylesheets, he'll just keep on strolling like a pimp.
+
+
+##How do I set this shit OFF?
+
+From your command line, make sure your ass in the right directory of your shit, then lay this down:
+
+    bundle exec tsscssd --appname [YOUR APP NAME] --stylesheets [PATH TO YOUR STYLESHEETS] --type [WHAT KIND OF STYLESHEETS ARE WE DEALING WITH] --output [WHERE YOU WANT THE DOPENESS] --skip [AN ARRAY OF FILES TO SKIP] =
+
+###Defaults
+
+If you don't want to provide this badass with parameters, then this is what you get:
+
+Appname           = 'My dope app'
+Stylesheets       = CURRENT DIRECTORY + '/app/assets/stylesheets/'
+@config[:output]  = CURRENT DIRECTORY + '/app/public'
+@config[:type]    = 'scss'
+@config[:skip]    = ['normalize']
+
 
-TODO: Write usage instructions here
+## But...but what about all this other shit I want it to do?
 
-## Contributing
+If you have suggestions about how to improve the TSSCSSD, please feel free to tell your
+collection of stuffed animals just before you cry yourself to sleep.
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+....................../´¯/)
+....................,/¯../
+.................../..../
+............./´¯/'...'/´¯¯`- ¸
+........../'/.../..../......./¨¯\
+........('(...´...´.... ¯~/'...')
+.........\.................'...../
+.........."...\.......... _.- ´
+............\..............(
+..............\.............\...

data/bin/tsscssd

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'tsscssd'
+require 'optparse'
+
+options   = { :report => true }
+op        = OptionParser.new
+
+op.on("-h", "--help") do
+  puts op.to_s
+  exit
+end
+
+op.on("-v", "--version") do
+  puts Tsscssd::VERSION
+  exit
+end
+
+appname_help            = "What the hell shall we call this App?"
+stylesheets_help        = "Tell me where your delicious stylesheets are."
+type_help               = "Tell me how these stylesheets are written. CSS? SASS? SCSS?"
+output_help             = "Tell me where to lay down the fat stacks of documentation."
+skip_help               = "Give the filename you want to skip. JUST THE NAME...like 'normalize.'"
+
+op.on("--appname     [STRING]",      appname_help) {|value| options[:appname] = value }
+op.on("--stylesheets [PATH]",        stylesheets_help) {|value| options[:stylesheets] = value }
+op.on("--type        [STRING]",      type_help) {|value| options[:type] = value }
+op.on("--output      [PATH]",        output_help) {|value| options[:output] = value }
+op.on("--skip        [STRING]",      skip_help) {|value| options[:skip] = value }
+
+begin
+  op.parse!(ARGV)
+  raise "Hey man...you need to pass me some paraemeter if you want this done correctly." if ARGV.empty?
+  Tsscssd.run!(ARGV[0], options)
+rescue Exception => ex
+  puts ex.message
+  exit
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tsscssd
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -46,18 +46,13 @@ dependencies:
 description: A stupid simple automated CSS styleguide based on your comments.
 email:
 - scottt2@uw.edu
-executables: []
+executables:
+- tsscssd
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE.txt
 - README.md
-- Rakefile
-- lib/tsscssd.rb
-- lib/tsscssd/version.rb
-- tsscssd.gemspec
+- bin/tsscssd
 homepage: ''
 licenses:
 - MIT

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in tsscssd.gemspec
-gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Tyler Scott
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/lib/tsscssd.rb

@@ -1,115 +0,0 @@
-require "tsscssd/version"
-module Tsscssd
-  
-  LIB         = File.dirname(__FILE__)
-  
-  autoload :Runner,  File.join(LIB, 'tsscssd/runner')
-  autoload :Builder,  File.join(LIB, 'tsscssd/builder')
-
-  def self.run!(input, config = {}, &block)
-    Runner.new(input, config).run!(&block)
-  end
-
-  class << self
-    attr_accessor :appname
-    attr_accessor :stylesheets
-    attr_accessor :output
-  end  
-  
-  class StyleGuide
-    def initialize
-      @files = []
-    end
-    def files
-      @files
-    end
-    def addFile(file)
-      cssFile = Tsscssd::CssFile.new(file)
-      @files.push(cssFile)
-    end
-  end
-  
-  class CssFile
-    def initialize(fileName)
-      @fileName = fileName
-      fn = fileName.split('/')
-      fn = fn[fn.length-1]
-      fn = fn.split('.')[0]
-      @prettyName = fn
-      @header = []
-      @imports = []
-      @comments = []
-      @lineNumber = 0
-      @inComment = false
-      @comment = ''
-      parseFile
-    end
-    def fileName
-      @fileName
-    end
-    def prettyName
-      @prettyName
-    end
-    def header
-      @header
-    end
-    def imports
-      @imports
-    end
-    def imports?
-      @imports.length > 0 ? true : false
-    end
-    def comments
-      @comments
-    end
-    def comments?
-      @comments.length > 0 ? true : false
-    end
-    def parseFile
-      File.open(fileName) do |file|
-        while @line = file.gets
-          @lineNumber = @lineNumber + 1
-          if @line
-            @line = @line.chomp
-            @words = @line.split
-            case @words[0]
-            when '/*'
-              #Begin the header comments. May need this for later.
-            when '*'
-              #puts 'Header Comment'
-              headerComment = @line.split('*')
-              value = @line.split('- ')
-              value = value[value.length-1]
-              key = headerComment[1].split[0]
-              @header.push({key:key, value:value})
-            when '*/'
-              #End header comments. May need this for later.
-            when '@import' # Collect those imports!
-              #puts 'In imports | ' + @words[1].split("'")[1]
-              @imports.push(@words[1].split("'")[1])
-            when '//' #ID the comment. Mark as inComment for the next pass to grab the right hand side.
-              #puts 'Inline Comment'
-              if @inComment == false
-                @inComment = true
-                @comment = @line.split('// ')
-                @comment = @comment.join.chomp
-              end
-            else
-              if @inComment == true   # grab the selector/variable for the comment we have ID'ed
-                if @line[0] == '$'
-                  @line = @line.split(':')[0]
-                elsif @line.split('{')[0].length < 2
-                  @line = @line.chomp(' {')
-                else
-                  @line = @line.split('{')[0]
-                end                
-                @comments.push({lineNumber:@lineNumber,selector:@line,comment:@comment})
-                @inComment = false
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/tsscssd/version.rb

@@ -1,3 +0,0 @@
-module Tsscssd
-  VERSION = "0.0.2"
-end

data/tsscssd.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tsscssd/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "tsscssd"
-  spec.version       = Tsscssd::VERSION
-  spec.authors       = ["Tyler Scott"]
-  spec.email         = ["scottt2@uw.edu"]
-  spec.description   = %q{A stupid simple automated CSS styleguide based on your comments.}
-  spec.summary       = %q{Mo' CSS? No problems!}
-  spec.homepage      = ""
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-end