spectra 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee1b6454f86dcc042a8b03acd6cf8660aa6baa86
-  data.tar.gz: 970a196f54c7562ed965fd13bf551b5eeb3f77e6
+  metadata.gz: 570f1ad695aa5a7555900c3d6fa42e00bb6bee17
+  data.tar.gz: eee2b8f331250c0389a6599c98c62c0b5d4a48ee
 SHA512:
-  metadata.gz: fbdcb8d68ee9cc39eee38d0df5085da70973af302e0ba8feee1e8f7ff66dde156a6b1bb9411d0b37f8d51e1f994b6c83281be83b029d6556537885ec9a0960df
-  data.tar.gz: b86738e123ee3d95ade7f5ceab28bd013bbea8a7d034b05078cdf48a41dd7658bb2bf2d8a9bebadaad5031164037055879fc8a72993a590d116144add2aa5e32
+  metadata.gz: 099a09753a9ad6f0dbb093dffa5fb1a6da18d1743a6dd4ac0a307f9e29323dba68b28c56e0b7e6f95b93aa02e60d64ee51c1783d5765f6d44b15e67c9625ebae
+  data.tar.gz: 4ac07c5bbd1cd9c71d7c0b8588bc6d74e7706f99d1f7d8d9aad60ab358852067354498c3a5cb4e50eca590d7439e85a920c613b290d2183de148f55d063837fd

data/.gitignore

@@ -20,8 +20,7 @@ tmp
 *.o
 *.a
 mkmf.log
+*.swp
 
-spectrum.rb
 .ruby-version
 .ruby-gemset
-

data/README.md

@@ -40,3 +40,16 @@ color :gray,    hex: 0xEEEEEE, a: 0.6
 color :white,   w: 1.0
 color :overlay, r: 0.8, g: 0.7, b: 0.2, a: 0.75
 ```
+
+## Installation
+
+Spectra is published as a Rubygem. Install with `gem`: 
+```ruby
+gem install spectra
+```
+
+Or `bundler`:
+```ruby
+gem 'spectra', '~> 0.1.1'
+```
+

data/bin/spectra

@@ -4,25 +4,63 @@ require 'spectra'
 require 'ostruct'
 require 'optparse'
 
+command_list = %Q(
+subcommands:
+  + create: creates a template spectrum.rb file
+)
+
+command_descriptions = {
+  base: %Q(
+  Invoke without a subcommand to generate colors from the spectrum.rb in the current directory
+),
+  create: %Q(
+  Creates a template spectrum.rb file populated with instructional defualts in the current directory.
+)}
+
 options = OpenStruct.new
-options.verbose = false
 
-OptionParser.new do |opts|
-  opts.banner = 'usage: spectra [-vh]'
- 
+main = OptionParser.new do |opts|
+  opts.banner = 'usage: spectra [options] [subcommand [options]]'
+
+  opts.separator command_descriptions[:base][1..-1]
+  opts.separator "\noptions:"
+  
   opts.on('-v', '--verbose', 'Enables verbose debugging output') do |flag|
-    options.verbose = true
+    options.verbose = flag 
   end
 
   opts.on('-d', '--dry-run', 'Processes colors without writing anything to disk') do |flag|
-    options.dry_run = true
+    options.dry_run = flag
   end
   
-  opts.on('-h', '--help', 'Shows this message') do |flag|
+  opts.on('-h', '--help', 'Shows this message') do 
     puts opts; exit 
   end
 
-end.parse!(ARGV)
+  opts.separator command_list
+
+end
+
+subcommands = {
+  create: OptionParser.new do |opts|
+    opts.banner = 'usage: create'
+    opts.separator command_descriptions[:create][1..-1]
+    
+    opts.separator "\noptions"
+    opts.on('-h', '--help', 'Shows this message') do
+      puts opts; exit
+    end
+  end
+}
+
+main.order! # order parses all possible arguments desctructively (in order, duh)
+subcommand = ARGV.shift.intern
+subcommands[subcommand].order! if subcommand 
 
-Spectra.generate(options)
+case subcommand
+  when :create
+    Spectra.create(options);
+  else
+    Spectra.generate(options)
+end
 

data/lib/spectra/color.rb

@@ -0,0 +1,35 @@
+
+require 'spectra/components'
+require 'spectra/utilities/extensions'
+
+module Spectra
+
+  class Color
+    
+    attr_accessor :name, :components
+   
+    def initialize(name, components)
+      self.name = name
+      self.components = components
+    end 
+
+    def respond_to?(name)
+      super || Components.valid?(name)
+    end
+
+    def method_missing(name)
+      Components.valid?(name) ? self.components[name] : super
+    end
+
+    ##
+    ## Debugging
+    ##
+
+    def to_s
+      "<color: #{name} colors: #{components.values_at(:red, :green, :blue, :alpha).map{|v| '%.2f' % (v || 0.0) }}>" 
+    end
+
+  end
+
+end
+

data/lib/spectra/components.rb

@@ -20,6 +20,10 @@ module Spectra
       components.each { |key, value| components[key] = self.normalize(value) }
     end
 
+    def self.hexify(components)
+      (components[:red] * 255 << 16) | (components[:green] * 255 << 8) | (components[:blue] * 255)
+    end
+
     def self.valid?(name)
       self.valid.include?(name)
     end
@@ -28,17 +32,12 @@ module Spectra
     ## Helpers
     ##
 
-    def self.componentize_hex(value)
-      hex = value.is_a?(String) ? value.to_i : value
-      Hash.new.tap do |hash| 
-        hash[:red]   = (hex & 0xFF0000) >> 16
-        hash[:green] = (hex & 0x00FF00) >> 8
-        hash[:blue]  = (hex & 0x0000FF)
-      end
+    def self.componentize_hex(hex)
+      { red: (hex & 0xFF0000) >> 16, green: (hex & 0x00FF00) >> 8, blue: (hex & 0x0000FF) }
     end
 
-    def self.componentize_white(value)
-      { red: value, green: value, blue: value }
+    def self.componentize_white(white)
+      { red: white, green: white, blue: white }
     end
 
     ##

data/lib/spectra/spectrum.rb

@@ -0,0 +1,57 @@
+
+require 'spectra/color'
+require 'spectra/views/factory'
+
+module Spectra
+  class Spectrum 
+    
+    attr_accessor :_prefix
+    attr_accessor :colors, :views
+
+    def generate(definition)
+      # evaluate color definition file, setup defaults
+      self.instance_eval(definition)
+      self.formats(:palette, :objc) unless self.views
+
+      # render views according to the specification
+      self.views.each do |view|
+        view.serialize({ colors: self.colors, prefix: self._prefix })
+      end
+    end 
+
+    ##
+    ## DSL
+    ##
+
+    def prefix(prefix)
+      self._prefix = prefix 
+    end
+  
+    def formats(*types) 
+      types.each { |type| format(type) }
+    end
+
+    def format(type, directory = nil, &renamer)
+      self.views ||= []
+      self.views.concat(Views.from_attributes({ type: type, directory: directory, renamer: renamer }))
+    end
+     
+    def color(name, attributes)
+      self.colors ||= [] 
+      self.colors << Color.new(name, Components.componentize(attributes))
+    end
+
+    def components(*components)
+      components.hash_from(:red, :green, :blue, :alpha)
+    end
+
+    def hex(*components)
+      components.hash_from(:hex, :alpha)
+    end
+
+    def white(*components)
+      components.hash_from(:white, :alpha)
+    end 
+  end
+end
+

data/lib/spectra/template.rb

@@ -0,0 +1,24 @@
+
+## replace with your desired class/method prefix (used where applicable)
+prefix :foo 
+
+## Formats
+
+## specify formats with `format` or `formats`
+format :palette
+
+## replace path with your own personal category directory
+format :objc, 'path/to/categories'
+
+## uncomment to customize the naming scheme for a particulary format
+# format :objc do |name, prefix|
+#   name.camelize(true)
+# end
+
+## Colors
+
+## note: the last component is always alpha, and can safely be omitted
+color :red,   (components 255, 0, 0, 1.0)
+color :gray,  (white 0.5, 1.0)
+color :green, (hex 0x00ff00, 1.0)
+

data/lib/spectra/version.rb

@@ -1,3 +1,3 @@
 module Spectra
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/spectra/views/factory.rb

@@ -0,0 +1,28 @@
+
+require 'spectra/views/palette'
+require 'spectra/views/objc_category'
+require 'spectra/views/swift_extension'
+
+module Spectra
+
+  module Views
+
+    def self.from_attributes(attributes)
+      klass = self.view_class(attributes[:type]) 
+      klass.from_attributes(attributes) 
+    end
+
+    def self.view_class(type)
+      case type.intern
+        when :palette
+          Palette
+        when :objc    
+          ObjcCategory
+        when :swift   
+          SwiftExtension
+      end
+    end
+
+  end
+
+end

data/lib/spectra/{templates → views}/objc_category.rb

@@ -1,12 +1,16 @@
 
-require 'spectra/templates/template'
+require 'spectra/views/view'
 
 module Spectra
 
-  class ObjcCategory < Template
+  class ObjcCategory < View 
     
     attr_accessor :is_header
 
+    def self.from_attributes(attributes)
+      [ self.new(attributes.merge(is_header: true)), self.new(attributes) ]
+    end
+
     def initialize(attributes)
       super 
       self.is_header = attributes[:is_header]
@@ -49,7 +53,7 @@ module Spectra
     ##
 
     def filename
-      "UIColor+#{self.class_prefix}Color.#{self.file_extension}"
+      super || "UIColor+#{self.class_prefix}Color.#{self.file_extension}"
     end
   
   end

data/lib/spectra/views/palette.rb

@@ -0,0 +1,27 @@
+
+require 'spectra/views/view'
+
+module Spectra
+
+  class Palette < View
+
+    def renamer
+      @renamer || lambda { |name, prefix| name.camelize(true) }
+    end
+
+    ##
+    ## Pathing 
+    ##
+    
+    def directory 
+      @directory || "#{Dir.home}/Library/Colors/"
+    end
+
+    def filename
+      super || "#{self.prefix}-palette.clr"
+    end
+
+  end 
+
+end
+

data/lib/spectra/views/serializable.rb

@@ -0,0 +1,34 @@
+
+module Spectra
+
+  module Serializable
+
+    attr_accessor :directory, :filename
+
+    def serialize(attributes)
+      text = self.render(attributes)
+      path = self.destination(attributes)
+
+      Spectra.logger.debug "#{Spectra.options.dry_run ? 'would write' : 'writing'} to: #{path}"
+       
+      if Spectra.options.dry_run
+        Spectra.logger.debug "\n#{text}"
+      else
+        File.open(path, 'w+') { |file| file.write(text) }
+      end
+    end
+
+    def destination(attributes)
+      destination = self.directory
+      destination << '/' unless destination.end_with?('/')
+      destination + self.filename
+    end
+
+    def directory 
+      @directory ||= './'
+    end
+
+  end
+
+end
+

data/lib/spectra/views/swift_extension.rb

@@ -0,0 +1,23 @@
+
+require 'spectra/views/view'
+
+module Spectra
+
+  class SwiftExtension < View
+    
+    def renamer
+      @renamer || lambda { |name, prefix| name.camelize(true) } 
+    end 
+
+    ##
+    ## Pathing
+    ##
+
+    def filename
+      super || 'Colors.swift' 
+    end
+
+  end
+
+end
+

data/lib/spectra/views/view.rb

@@ -0,0 +1,120 @@
+
+require 'mustache'
+require 'spectra/components'
+require 'spectra/utilities/extensions'
+require 'spectra/views/serializable'
+
+module Spectra
+
+  class View < Mustache
+
+    include Serializable
+
+    attr_accessor :colors, :renamer, :prefix
+
+    def initialize(attributes)
+      self.directory = attributes[:directory]
+      self.filename  = attributes[:filename]
+      self.renamer   = attributes[:renamer]
+    end
+
+    def self.from_attributes(attributes)
+      [ self.new(attributes) ]
+    end
+
+    ##
+    ## Mustache
+    ##
+
+    self.path = File.dirname(__FILE__) 
+     
+    def self.template_name
+       super.split('/').last
+    end  
+
+    ##
+    ## Rendering
+    ##
+
+    def render(attributes)
+      self.prefix = attributes[:prefix]
+      self.colors = self.views_from_colors(attributes[:colors])
+      super() # offload to Mustache
+    end
+
+    def views_from_colors(colors)
+      colors.map do |color| 
+        ColorView.new(color, {
+          name:  proc { |c| self.format_color_name(c) },
+          value: proc { |v| self.format_color_value(v) }
+        }) 
+      end
+    end
+
+    def format_color_name(name)
+      self.renamer.call(name, self.prefix)
+    end
+
+    def format_color_value(value)
+      '%.2f' % (value || 0.0)
+    end 
+
+    ##
+    ## Debugging
+    ##
+
+    def to_s
+      "<#{self.class.name} => #{self.path}, renamer: #{@renamer}>"
+    end
+
+  end
+
+  class ColorView
+
+    attr_accessor :color, :formatters
+    
+    def initialize(color, formatters)    
+      self.color = color 
+      self.formatters = formatters
+    end
+
+    def respond_to?(name)
+      super || self.color.respond_to?(name)
+    end
+
+    def method_missing(name, *args)
+      if Components.valid?(name)
+        self.format(:value, self.color.send(name, *args))
+      else
+        super
+      end
+    end
+
+    ##
+    ## Accessors
+    ##
+
+    def name
+      self.format(:name, self.color.name)
+    end
+
+    def hex
+      self.format(:value, Components.hexify(self.color.components))
+    end    
+
+    def format(type, value)
+      self.formatters[type].call(value)
+    end 
+
+    ##
+    ## Debugging
+    ##
+
+    def to_s
+      "<view => #{self.color}>"
+    end
+
+  end
+
+end
+

data/lib/spectra.rb

@@ -1,17 +1,16 @@
 
 require 'spectra/version'
-require 'spectra/logger'
-require 'spectra/models'
+require 'spectra/spectrum'
+require 'spectra/utilities/logger'
 
 module Spectra
   
   class << self
-    attr_accessor :logger, :options 
+    attr_accessor :logger, :options
   end 
  
   def self.generate(options)
     self.options = options
-    logger.level = options.verbose ? Logger::DEBUG : Logger::INFO
 
     begin
       definition = IO.read('spectrum.rb')
@@ -19,13 +18,30 @@ module Spectra
       logger.terminate "Failed to read spectrum.rb file: #{execption}" 
     end 
 
-    spectra = Root.new
-    spectra.generate(definition)
+    spectrum = Spectrum.new
+    spectrum.generate(definition)
   end 
 
+  def self.create(options)
+    self.options = options
+
+    begin
+      IO.copy_stream(File.dirname(__FILE__) + '/spectra/template.rb', 'spectrum.rb')
+    rescue Exception => exception
+      logger.terminate "Failed to create spectrum.rb file: #{exception}"
+    else
+      logger.info "created #{Dir.pwd}/spectrum.rb"
+    end
+  end
+
   def self.logger
     @logger ||= SpectraLogger.new(STDOUT) 
   end
 
+  def options=(options)
+    @options = options
+    self.logger.level = options.verbose ? Logger::DEBUG : Logger::INFO
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spectra
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ty Cobb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-03 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,21 +68,22 @@ files:
 - Rakefile
 - bin/spectra
 - lib/spectra.rb
+- lib/spectra/color.rb
 - lib/spectra/components.rb
-- lib/spectra/dsl.rb
-- lib/spectra/extensions.rb
-- lib/spectra/logger.rb
-- lib/spectra/models.rb
-- lib/spectra/serializer.rb
-- lib/spectra/templates/factory.rb
-- lib/spectra/templates/objc_category.mustache
-- lib/spectra/templates/objc_category.rb
-- lib/spectra/templates/palette.mustache
-- lib/spectra/templates/palette.rb
-- lib/spectra/templates/swift_extension.mustache
-- lib/spectra/templates/swift_extension.rb
-- lib/spectra/templates/template.rb
+- lib/spectra/spectrum.rb
+- lib/spectra/template.rb
+- lib/spectra/utilities/extensions.rb
+- lib/spectra/utilities/logger.rb
 - lib/spectra/version.rb
+- lib/spectra/views/factory.rb
+- lib/spectra/views/objc_category.mustache
+- lib/spectra/views/objc_category.rb
+- lib/spectra/views/palette.mustache
+- lib/spectra/views/palette.rb
+- lib/spectra/views/serializable.rb
+- lib/spectra/views/swift_extension.mustache
+- lib/spectra/views/swift_extension.rb
+- lib/spectra/views/view.rb
 - spectra.gemspec
 homepage: https://github.com/derkis/Spectrum
 licenses:

data/lib/spectra/dsl.rb

@@ -1,52 +0,0 @@
-
-require 'spectra/components'
-require 'spectra/serializer'
-
-module Spectra
-
-  module DSL
-    def prefix(prefix)
-      self._prefix = prefix 
-    end
-  
-    def formats(*types) 
-      types.each { |type| format(type) }
-    end
-
-    def format(type, path = nil, &renamer)
-      self.serializers ||= []
-      
-      serializers = Serializer.from_type(type, {
-        path: path,
-        template: { type: type, renamer: renamer }  
-      })
-      self.serializers.concat(serializers)
-      
-      serializers.each { |serializer| Spectra.logger.debug "dsl add: #{serializer}" }
-    end
-     
-    def color(name, attributes)
-      self.colors ||= []
-      
-      color = Color.new(name, Components.componentize(attributes))
-      self.colors << color
-
-      Spectra.logger.debug "dsl add: #{color}"
-    end
-
-    def components(*components)
-      components.hash_from(:red, :green, :blue, :alpha)
-    end
-
-    def hex(*components)
-      components.hash_from(:hex, :alpha)
-    end
-
-    def white(*components)
-      components.hash_from(:white, :alpha)
-    end
-     
-  end 
-
-end
-

data/lib/spectra/models.rb

@@ -1,57 +0,0 @@
-
-require 'spectra/extensions'
-require 'spectra/components'
-require 'spectra/dsl'
-
-module Spectra
-
-  class Root
-    
-    attr_accessor :_prefix
-    attr_accessor :colors, :serializers
-
-    include DSL
-
-    def generate(definition) 
-      self.instance_eval(definition)
-      self.formats(:palette, :objc) unless self.serializers
-
-      self.serializers.each do |serializer|
-        serializer.serialize({
-          colors: self.colors,
-          prefix: self._prefix,  
-        })
-      end
-    end 
-
-  end
-
-  class Color
-    
-    attr_accessor :name, :components
-   
-    def initialize(name, components)
-      self.name = name
-      self.components = components
-    end 
-
-    def respond_to?(name)
-      super || Components.valid?(name)
-    end
-
-    def method_missing(name)
-      Components.valid?(name) ? self.components[name] : super
-    end
-
-    ##
-    ## Debugging
-    ##
-
-    def to_s
-      "<color: #{name} colors: #{components.values_at(:red, :green, :blue, :alpha).map{|v| v.is_a?(String) ? v : '%.2f' % (v || 0.0) }}>" 
-    end
-
-  end
-
-end
-

data/lib/spectra/serializer.rb

@@ -1,60 +0,0 @@
-
-require 'spectra/extensions'
-require 'spectra/templates/factory'
-
-module Spectra
-
-  class Serializer
-
-    attr_accessor :template, :path
-
-    def initialize(attributes)
-      self.path     = attributes[:path]
-      self.template = Template.from_attributes(attributes[:template])
-    end
-
-    def serialize(attributes)
-      text = self.template.render(attributes)
-      path = self.resource_path(attributes)
-
-      Spectra.logger.debug "#{Spectra.options.dry_run ? 'would write' : 'writing'} to: #{path}" 
-
-      if Spectra.options.dry_run
-        Spectra.logger.debug "\n#{text}"
-      else
-        File.open(path, 'w+') { |file| file.write(text) }
-      end
-    end
-
-    def resource_path(attributes)
-      resource_path = self.path || self.template.path
-      resource_path << '/' unless resource_path.end_with?('/')
-      resource_path + self.template.filename
-    end
-
-    ##
-    ## Factory
-    ##
-
-    def self.from_type(type, attributes)
-      case type.intern
-        when :palette, :swift
-          [ Serializer.new(attributes) ]
-        when :objc
-          [ Serializer.new(attributes.deep_merge(template: { is_header: true })), Serializer.new(attributes) ]
-        else raise "Specfied an invalid serializer type: #{type}"
-      end
-    end
-
-    ##
-    ## Debugging
-    ##
-
-    def to_s
-      "<serializer => #{self.path || './'}, #{self.template}>"
-    end
-
-  end
-
-end
-

data/lib/spectra/templates/factory.rb

@@ -1,23 +0,0 @@
-
-require 'spectra/templates/palette'
-require 'spectra/templates/objc_category'
-require 'spectra/templates/swift_extension'
-
-module Spectra
-
-  class Template
-
-    def self.from_attributes(attributes)
-      case attributes[:type].intern
-        when :palette
-          Palette.new(attributes)
-        when :objc    
-          ObjcCategory.new(attributes)
-        when :swift   
-          SwiftExtension.new(attributes)
-      end
-    end
-
-  end
-
-end

data/lib/spectra/templates/palette.rb

@@ -1,27 +0,0 @@
-
-require 'spectra/templates/template'
-
-module Spectra
-
-  class Palette < Template
-
-    def renamer
-      @renamer ||= lambda { |name, prefix| name.camelize(true) }
-    end
-
-    ##
-    ## Pathing 
-    ##
-    
-    def path
-      "#{Dir.home}/Library/Colors/"
-    end
-
-    def filename
-      "#{self.prefix}-palette.clr"
-    end
-
-  end 
-
-end
-

data/lib/spectra/templates/swift_extension.rb

@@ -1,23 +0,0 @@
-
-require 'spectra/templates/template'
-
-module Spectra
-
-  class SwiftExtension < Template
-    
-    def renamer
-      @renamer ||= lambda { |name, prefix| name.camelize(true) } 
-    end 
-
-    ##
-    ## Pathing
-    ##
-
-    def filename
-      return 'Colors.swift' 
-    end
-
-  end
-
-end
-

data/lib/spectra/templates/template.rb

@@ -1,73 +0,0 @@
-
-require 'mustache'
-
-module Spectra
-
-  class Template < Mustache
-   
-    attr_accessor :renamer, :colors, :prefix
-    
-    def initialize(attributes)
-      self.renamer = attributes[:renamer] 
-    end 
-
-    ##
-    ## Mustache
-    ##
-
-    self.path = 'lib/spectra/templates'
-     
-    def self.template_name
-       super.split('/').last
-    end 
-    
-    ##
-    ## Rendering 
-    ## 
-
-    def render(attributes)
-      self.prefix = attributes[:prefix]
-      self.colors = parse_colors(attributes[:colors])
-      super() # offload to Mustache
-    end
-
-    def parse_colors(colors)
-      colors.map { |color| self.parse_color(color) }
-    end
-
-    def parse_color(color)
-      copy = color.clone  
-      copy.name = self.format_color_name(color)
-      copy.components = color.components.map do |key, value| 
-        [ key, self.format_color_value(value) ] 
-      end.to_h
-      copy
-    end
-
-    def format_color_name(color)
-      self.renamer.call(color.name, self.prefix)
-    end
-
-    def format_color_value(value)
-      '%.2f' % (value || 0.0)
-    end
-    
-    ##
-    ## Pathing
-    ##
-
-    def path 
-      './'
-    end
-
-    ##
-    ## Debugging
-    ##
-
-    def to_s 
-      "<template: #{self.class.name} renamer: #{@renamer}>"
-    end
-    
-  end
-
-end