spark_engine 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e14e3ea9f6106b145bd3c3a68525a2bf4bc20682aecf4c23844ecf6b2d2db7a1
+  data.tar.gz: c10f52044b61ee93dafb647fdd80ed18291fbe3d7f5d5110b662fde42d7bab52
+SHA512:
+  metadata.gz: 4d35cd50784a6fca125005939335ee5359f3adb6929db9cb63cb61248fb90be2d526b9b4334348aef63086627cd1ec931d35fbafef0ee4e955313e048c85e323
+  data.tar.gz: 2821d2dc7ce2d36d9f354768243e195e62b9f1f7e55dc26806dd3e472a604d67bdeef2d1631163cb61dc4c8522efe3c1fb32f3fb14689aa14ff95c61f4b2f79e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/
+.DS_Store
+node_modules

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at brandon@imathis.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brandon Mathis
+
+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/README.md

@@ -0,0 +1,34 @@
+# Spark
+
+A design systems framework for Rails.
+
+
+## Installation
+
+First install the gem.
+
+```sh
+gem install spark_engine
+```
+
+Generate a new engine with Spark.
+
+```sh
+spark new your_plugin
+```
+
+This will create a new gem and generate the scaffolding for a Spark Rails Engine.
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/imathis/spark. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/spark

@@ -0,0 +1,99 @@
+#! /usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require 'optparse'
+require 'spark_engine'
+require 'spark_engine/command'
+require "spark_engine/command/help"
+
+options = {
+  path: '.'
+}
+
+def next_arg
+  if ARGV.first && !ARGV.first.match(/^-/)
+    ARGV.shift
+  end
+end
+
+OptionParser.new do |opts|
+
+  options[:help] = ARGV.shift if %w(help h).include?(ARGV.first)
+
+  if ARGV.empty?
+    options[:help] = true
+  else
+    options[:command] = next_arg
+  end
+
+  opts.banner = SparkEngine::Help.banner(options[:command])
+
+  if %w(n new).include? options[:command]
+    options[:name] = next_arg
+
+    opts.on("-e", "--engine ENGINE_NAME", String, "Name the engine (defaults to gem name)") do |engine|
+      options[:engine] = engine
+    end
+
+    opts.on("-f", "--force", "overwrite existing files") do |val|
+      options[:force] = true
+    end
+  end
+
+  if %w(s server).include? options[:command]
+    opts.on("-w", "--watch", "Watch assets") do |val|
+      options[:watch] = true
+    end
+  end
+
+  if %w(b w s build watch server).include? options[:command]
+    opts.on("-j", "--js", "Build javascripts.") do |val|
+      options[:select_assets] = true
+      options[:js] = true
+    end
+
+    opts.on("-c", "--css", "Build css.") do |val|
+      options[:select_assets] = true
+      options[:css] = true
+    end
+
+    opts.on("-s", "--svg", "Build svgs.") do |val|
+      options[:select_assets] = true
+      options[:svg] = true
+    end
+
+    opts.on("-P", "--production", "Build assets as with production mode.") do |val|
+      ENV['RAILS_ENV'] = 'production'
+      options[:production] = true
+    end
+
+    opts.on("-C", "--clean", "Remove cache files before build.") do |val|
+      options[:clean] = true
+    end
+  end
+
+  if %w(s server).include? options[:command]
+    opts.on("-p", "--port PORT", String, "serve site at port") do |val|
+      options[:port] = val
+    end
+    
+    opts.on("-b", "--bind HOST", String, "Bind to a specific host, e.g. 0.0.0.0") do |val|
+      options[:host] = val
+    end
+  end
+
+  opts.on("-v", "--version", "Print version") do |version|
+    options[:command] = 'version'
+  end
+
+  opts.on("-h", "--help", "Print this message") do |version|
+    options[:help] = opts
+  end
+
+  if options[:help]
+    options[:help] = opts
+  end
+end.parse!
+
+SparkEngine::Command.run(options)

data/lib/spark_engine/assets.rb

@@ -0,0 +1,8 @@
+module SparkEngine
+  module Assets
+    autoload :AssetType,     'spark_engine/plugin/assets/asset'
+    autoload :Stylesheets,   'spark_engine/plugin/assets/stylesheets'
+    autoload :Javascripts,   'spark_engine/plugin/assets/javascripts'
+    autoload :Svgs,          'spark_engine/plugin/assets/svgs'
+  end
+end

data/lib/spark_engine/command/help.rb

@@ -0,0 +1,86 @@
+module SparkEngine
+  module Help
+    extend self
+
+    def banner(command=nil)
+      if command.nil?
+        <<-HERE
+General Commands (run from anywhere):
+  #{spark_commands.map{|c| commands(c) }.join("\n  ")}
+
+Engine Commands (run these from your project's directory)
+  #{engine_commands.map{|c| commands(c) }.join("\n  ")}
+
+For help with a specific command, run `spark help command`
+
+Options:
+        HERE
+      elsif commands(command)
+        "\nUsage:\n  spark #{commands(command)}\n\nOptions:\n"
+      end
+    end
+
+    def engine_commands
+      %w(help build watch server help gem:build gem:install gem:release)
+    end
+
+    def spark_commands
+      %w(new help)
+    end
+
+    def commands(command)
+      case command
+      when 'new', 'n'; new
+      when 'help', 'h'; help
+      when 'build', 'b'; build
+      when 'watch', 'w'; watch
+      when 'server', 's'; server
+      when 'clean', 'c'; clean
+      when 'help', 'h'; help
+      when 'gem:build'; gem_build
+      when 'gem:install'; gem_install
+      when 'gem:release'; gem_release
+      end
+    end
+
+    def new
+      "new name [options]   # Create a new Spark framework engine"
+    end
+
+    def help
+      "help [command]       # Show help for a specific command"
+    end
+
+    def build
+      "build [options]      # Build assets"
+    end
+
+    def watch
+      "watch [options]      # Build assets when files change"
+    end
+
+    def server
+      "server [options]     # Serve documentation site"
+    end
+
+    def clean
+      "clean                # Remove cache files"
+    end
+
+    def help
+      "help [command]       # Show help for a specific command"
+    end
+
+    def gem_build
+      "gem:build            # Build assets for production and build gem"
+    end
+
+    def gem_install
+      "gem:install          # Build assets for production, build, and install gem"
+    end
+
+    def gem_release
+      "gem:release          # Build assets for production, build, and release gem to rubygems.org"
+    end
+  end
+end

data/lib/spark_engine/command/npm.rb

@@ -0,0 +1,62 @@
+module SparkEngine
+  module NPM
+    extend self
+
+    require "yaml"
+
+    DEPENDENCIES = YAML.load %Q{
+    private: true
+    devDependencies:
+      browserify:   ^16.2.1
+      browserify-incremental: ^3.1.1
+      svgo:         ^1.0.5
+    }
+
+    def setup
+      puts "\nAdding npm dependencies…".bold
+
+      if File.exist?(package_path)
+        update_package_json
+      else
+        write_package_json(DEPENDENCIES)
+      end
+    end
+
+    def package_path
+      File.join(Dir.pwd, 'package.json')
+    end
+
+    def write_package_json(contents)
+      File.open(package_path, 'w') do |io|
+        io.write(JSON.pretty_generate(contents))
+      end
+
+      puts "create".rjust(12).colorize(:green).bold + "  #{package_path}"
+    end
+
+    def read_package_json
+      JSON.parse File.read(package_path)
+    end
+
+    def update_package_json
+      package = read_package_json
+      package['dependencies']    ||= {}
+      package['devDependencies'] ||= {}
+
+      deps = DEPENDENCIES['devDependencies']
+
+      deps.keys.each do |dep|
+        d = deps[dep]
+
+        if package['devDependencies'][dep].nil? && package['dependencies'][dep].nil?
+          package['devDependencies'][dep] = d
+        end
+      end
+
+      package.delete('dependencies') if package['dependencies'].empty?
+      
+      write_package_json(package)
+    end
+
+  end
+end

data/lib/spark_engine/command.rb

@@ -0,0 +1,156 @@
+module SparkEngine
+  module Command
+    extend self
+
+    def run(options)
+      @production = options[:production]
+
+      if options[:help]
+        version
+        puts options[:help]
+        return
+      end
+
+      case options[:command]
+      when 'new', 'n'
+        require "spark_engine/scaffold"
+        Scaffold.new(options)
+      when 'build', 'b'
+        from_root { dispatch(:build, options) }
+      when 'watch', 'w'
+        from_root { dispatch(:watch, options) }
+      when 'server', 's'
+        from_root { dispatch(:server, options) }
+      when 'clean', 'c'
+        from_root { clean }
+      when 'version'
+        version
+      when 'gem:build'
+        from_root { gem_build }
+      when 'gem:install'
+        from_root { gem_install }
+      when 'gem:release'
+        from_root { gem_release }
+      when 'gem:tag'
+        from_root { gem_tag }
+      else
+        puts "Command `#{options[:command]}` not recognized"
+      end
+    end
+
+    def version
+      spec = SparkEngine.plugin_spec
+      puts "spark_engine v #{SparkEngine::VERSION}"
+      puts " - #{spec.name} v #{spec.version}\n" if spec
+      puts ""
+    end
+
+    def production?
+      @production == true
+    end
+
+    def gem_build
+      @production = true
+      FileUtils.rm_rf('public')
+      dispatch(:build)
+      system "bundle exec rake build"
+    end
+
+    def gem_install
+      @production = true
+      FileUtils.rm_rf('public')
+      dispatch(:build)
+      system "bundle exec rake install"
+    end
+
+    def gem_release
+      @production = true
+      gem_build
+      spec = SparkEngine.plugin_spec
+      gem_file = "./pkg/#{spec.gem}-#{spec.version}.gem"
+
+      if File.exists?(gem_file)
+        system "git commit -m v#{spec.version}"
+        system "git tag v#{spec.version}"
+        system "git push origin $(git rev-parse --abbrev-ref HEAD) --tag"
+
+        if key = ENV['RUBYGEMS_API_KEY']
+          gem = "#{spec.name}-#{spec.version}.gem"
+          system "bundle exec rake build"
+          system "curl --data-binary @./pkg/#{gem} -H 'Authorization:#{key}' https://rubygems.org/api/v1/gems"
+        else
+          system "gem push #{gem_file}"
+          system "rm ./public/*.gz"
+        end
+      end
+    end
+
+    def gem_tag
+      system "git tag v#{SparkEngine.plugin_spec.version}"
+    end
+
+    def require_rails
+      require File.join(Dir.pwd, SparkEngine.rails_path('config/application'))
+    end
+
+    def clean
+      FileUtils.rm_rf('public')
+      FileUtils.rm_rf(SparkEngine.rails_path('tmp/cache/'))
+      FileUtils.rm_rf('.sass-cache')
+      FileUtils.rm_rf(SparkEngine.rails_path('.sass-cache'))
+    end
+
+    # Handles running threaded commands
+    #
+    def dispatch(command, *args)
+      @threads = []
+      send command, *args
+      @threads.each { |thr| thr.join }
+    end
+
+    # Build assets
+    def build(options={})
+      puts SparkEngine.production? ? 'Building for production…' : 'Building…'
+      require_rails
+      clean if SparkEngine.production?
+      SparkEngine.plugin.build(options)
+    end
+
+    # Watch assets for changes and build
+    def watch(options={})
+      build(options)
+      require 'listen'
+
+      trap("SIGINT") {
+        puts "\nspark_engine watcher stopped. Have a nice day!"
+        exit!
+      }
+
+      @threads.concat SparkEngine.load_plugin.watch(options)
+    end
+
+    # Run rails server and watch assets
+    def server(options={})
+      options[:port] ||= 3000
+      @threads << Thread.new { system "#{SparkEngine.rails_path('bin/rails')} server -p #{options[:port]}" }
+      watch(options) if options[:watch]
+    end
+
+    def from_root(command=nil, &blk)
+      unless SparkEngine.gem_path
+        abort "Command must be run from the root of an engine (adjacent to the gemspec)."
+      end
+
+      Dir.chdir(SparkEngine.gem_path) do
+        if command
+          system command
+        else
+          blk.call
+        end
+      end
+    end
+
+  end
+end
+
+

data/lib/spark_engine/config_data.rb

@@ -0,0 +1,29 @@
+module SparkEngine
+  module ConfigData
+    extend self
+    def read(*roots)
+      @data ||= {}
+
+      data_files(*roots).each do |path|
+        name = File.basename(path, '.*')
+        case File.extname(path)
+        when '.json'
+          @data[name] = JSON.parse(File.read(path))
+        when '.yml'
+          @data[name] = YAML.load_file(path)
+        end
+      end
+
+      @data
+    end
+
+    def data_files(*roots)
+      files = []
+      [roots].flatten.each do |root|
+        files.concat Dir[File.join(root, 'config/data/**/*.json')]
+        files.concat Dir[File.join(root, 'config/data/**/*.yml')]
+      end
+      files.flatten.compact.uniq
+    end
+  end
+end

data/lib/spark_engine/helpers/asset_helpers.rb

@@ -0,0 +1,66 @@
+module SparkEngine
+  module Helpers
+    module AssetsHelper
+
+      def spark_asset_url(file)
+        SparkEngine.plugin.asset_url(file)
+      end
+
+      def stylesheet_tag(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        tags = ''
+
+        stylesheet_url(args).each do |url|
+          tags += stylesheet_link_tag url, options
+        end
+
+        tags.html_safe
+      end
+
+      def javascript_tag(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        tags = ''
+
+        javascript_url(args).each do |url|
+          tags += javascript_include_tag url, options
+        end
+
+        tags.html_safe
+      end
+
+      def stylesheet_url(*args)
+        SparkEngine.plugin.stylesheets.urls(args)
+      end
+
+      def javascript_url(*args)
+        SparkEngine.plugin.javascripts.urls(args)
+      end
+
+      def asset_tags
+        stylesheet_tag + javascript_tag
+      end
+
+      def pin_tab_icon_tag(path, color="black")
+        %Q{<link rel="mask-icon" mask href="#{spark_asset_url(path)}" color="#{color}">}.html_safe
+      end
+
+      def favicon_tag(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        source = args.first || 'favicon.ico'
+        tag('link', {
+          :rel  => 'shortcut icon',
+          :type => 'image/x-icon',
+          :href => spark_asset_url(source)
+        }.merge!(options.symbolize_keys))
+      end
+
+      def sass_data(key=nil)
+        if key
+          SparkEngine.plugin.stylesheets.data[key]
+        else
+          SparkEngine.plugin.stylesheets.data
+        end
+      end
+    end
+  end
+end

data/lib/spark_engine/helpers/layout_helpers.rb

@@ -0,0 +1,21 @@
+module SparkEngine
+  module Helpers
+    module LayoutHelper
+      def render_layout(*args, &block)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        layout = args.first || 'default'
+        options[:template] = "layouts/#{layout}"
+        yield if block_given?
+        render options
+      end
+
+      def javascripts(&block)
+        content_for :javascripts, &block
+      end
+
+      def stylesheets(&block)
+        content_for :stylesheets, &block
+      end
+    end
+  end
+end