bourbon_integrator 1.0.0

data/README.md

@@ -0,0 +1,73 @@
+# BourbonIntegrator
+
+[![Gem Version](https://badge.fury.io/rb/bourbon_integrator.svg)](http://badge.fury.io/rb/bourbon_integrator)
+
+## Assumptions
+
+* joins the [bourbon][bourbon] gem and its components into project dependencies
+* provides tasks for assets management
+* initialize the base structure
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bourbon_integrator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bourbon_integrator
+
+## Configuration
+
+Through `BourbonIntegrator::Config` class:
+
+```ruby
+config = BourbonIntegrator::Config.new(
+  "project_css_dir" => "css_dir"            # default: "stylesheets"
+  "project_images_dir" => "img_dir"         # default: "images"
+  "project_font_dir" => "font_dir"          # default: "fonts"
+  "project_assets_verbose" => true          # default: false
+  "project_cdn_url" => "http://cdn.net"     # default: nil
+  "project_assets_http_path" => "assets"    # default: "/"
+  "project_ui_dir" => "ui_dir"              # default: "."
+  "project_public_dir" => "pub_dir"         # default: "public"
+  "project_sass_dir" => "sass_dir"          # default: "sass"
+)
+```
+
+## Usage
+
+Add to project's Rakefile:
+```ruby
+require 'bourbon_integrator'
+BourbonIntegrator::Tasks.load(BourbonIntegrator::Config.new)
+```
+
+and list available tasks:
+```ruby
+bundle exec rake -T
+# rake bi:clean    # Remove compiled css
+# rake bi:compile  # Compile css
+# rake bi:init     # Initialize base structure
+# rake bi:watch    # Run sass watch
+```
+
+## Versioning
+
+See [semver.org][semver]
+
+## Contributing
+
+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
+
+[semver]: http://semver.org/
+[bourbon]: http://bourbon.io/

data/data/bourbon_integrator/struct_vars.scss.mustache

@@ -0,0 +1,3 @@
+$http_stylesheets_path = {{ http_stylesheets_path }}
+$http_images_path = {{ http_images_path }}
+$http_fonts_path = {{ http_fonts_path }}

data/lib/bourbon_integrator/command/clean.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "bourbon_integrator/command_template"
+
+module BourbonIntegrator
+  module Command
+    class Clean < CommandTemplate
+      def run
+        stylesheets_path = File.join(
+          @config.fetch("project_ui_dir"),
+          @config.fetch("project_public_dir"),
+          @config.fetch("project_css_dir")
+        )
+        @output.puts "*** Remove compiled CSS ***"
+        @executor.system "rm -rf #{stylesheets_path}/*"
+      end
+    end
+  end
+end

data/lib/bourbon_integrator/command/compile.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "bourbon_integrator/command_template"
+
+module BourbonIntegrator
+  module Command
+    class Compile < CommandTemplate
+      def run
+        @output.puts "*** Compile CSS ***"
+        @executor.system(
+          "sass --scss --style #{sass_style} --update #{sass_path}:#{stylesheets_path}"
+        )
+      end
+    end
+  end
+end

data/lib/bourbon_integrator/command/init.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "bourbon_integrator/command_template"
+require "fileutils"
+require "mustache"
+
+module BourbonIntegrator
+  module Command
+    class Init < CommandTemplate
+      def run
+        generate_bourbon_dir
+        generate_neat_dir
+        generate_bitters_dir
+        generate_struct_vars
+      end
+
+      def generate_bourbon_dir
+        @output.puts "*** Initialize bourbon ***"
+        @executor.system "bourbon install --path #{sass_path}"
+      end
+
+      def generate_neat_dir
+        @output.puts "*** Initialize neat ***"
+        @executor.system "cd #{sass_path} && neat install"
+      end
+
+      def generate_bitters_dir
+        @output.puts "*** Initialize bitters ***"
+        @executor.system "bitters install --path #{sass_path}"
+      end
+
+      def generate_struct_vars
+        return if File.exist?(vars_file_path)
+        @output.puts "*** Creating _struct_vars file ***"
+        FileUtils.mkdir_p sass_path
+        File.open(vars_file_path, "w") do |f|
+          f.write render_vars_file
+        end
+      end
+
+      private
+
+      def render_vars_file
+        ::Mustache.render(
+          IO.read(default_vars_file_path),
+          http_stylesheets_path: http_stylesheets_path,
+          http_images_path: http_images_path,
+          http_fonts_path: http_fonts_path
+        )
+      end
+
+      def http_stylesheets_path
+        File.join(
+          http_base_path,
+          @config.fetch("project_css_dir")
+        )
+      end
+
+      def http_images_path
+        File.join(
+          http_base_path,
+          @config.fetch("project_images_dir")
+        )
+      end
+
+      def http_fonts_path
+        File.join(
+          http_base_path,
+          @config.fetch("project_font_dir")
+        )
+      end
+
+      def http_base_path
+        File.join(
+          @config.fetch("project_cdn_url").to_s,
+          @config.fetch("project_assets_http_path")
+        )
+      end
+    end
+  end
+end

data/lib/bourbon_integrator/command/watch.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "bourbon_integrator/command_template"
+
+module BourbonIntegrator
+  module Command
+    class Watch < CommandTemplate
+      def run
+        @output.puts "*** Watching for changes ***"
+        @executor.exec "sass --scss --style #{sass_style} --watch #{sass_path}:#{stylesheets_path}"
+      end
+    end
+  end
+end

data/lib/bourbon_integrator/command_template.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module BourbonIntegrator
+  class CommandTemplate
+    def initialize(config:, output: $stdout, executor: ::Kernel)
+      @config = config
+      @output = output
+      @executor = executor
+    end
+
+    def run
+      raise NotImplementedError
+    end
+
+    private
+
+    def sass_path
+      File.join(
+        Rake.application.original_dir,
+        @config.fetch("project_ui_dir"),
+        @config.fetch("project_sass_dir")
+      )
+    end
+
+    def sass_style
+      @config.fetch("project_assets_verbose") ? "nested" : "compressed"
+    end
+
+    def stylesheets_path
+      File.join(
+        @config.fetch("project_ui_dir"),
+        @config.fetch("project_public_dir"),
+        @config.fetch("project_css_dir")
+      )
+    end
+
+    def vars_file_path
+      File.join(
+        sass_path,
+        "_struct_vars.scss"
+      )
+    end
+
+    def default_vars_file_path
+      File.join(
+        Gem.datadir("bourbon_integrator"),
+        "struct_vars.scss.mustache"
+      )
+    end
+  end
+end

data/lib/bourbon_integrator/config.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "piko_model"
+
+module BourbonIntegrator
+  class Config < PikoModel::Model
+    field "project_css_dir", default: "stylesheets"
+    field "project_images_dir", default: "images"
+    field "project_font_dir", default: "fonts"
+    field "project_assets_verbose", default: false
+    field "project_cdn_url", default: nil
+    field "project_assets_http_path", default: "/"
+    field "project_ui_dir", default: "."
+    field "project_public_dir", default: "public"
+    field "project_sass_dir", default: "sass"
+  end
+end

data/lib/bourbon_integrator/tasks/compass.rake

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "bourbon_integrator/command/clean"
+require "bourbon_integrator/command/compile"
+require "bourbon_integrator/command/watch"
+
+namespace :bi do
+  desc "Remove compiled css"
+  task :clean do
+    BourbonIntegrator::Command::Clean.new(config: BourbonIntegrator::Tasks.config).run
+  end
+
+  desc "Compile css"
+  task compile: %w(clean) do
+    BourbonIntegrator::Command::Compile.new(config: BourbonIntegrator::Tasks.config).run
+  end
+
+  desc "Run compass watch"
+  task :watch do
+    BourbonIntegrator::Command::Watch.new(config: BourbonIntegrator::Tasks.config).run
+  end
+
+  task c: %w(compile)
+  task w: %w(watch)
+end

data/lib/bourbon_integrator/tasks/init.rake

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "bourbon_integrator/command/init"
+
+namespace :bi do
+  desc "Initialize base structure"
+  task :init do
+    BourbonIntegrator::Command::Init.new(config: BourbonIntegrator::Tasks.config).run
+  end
+end

data/lib/bourbon_integrator/tasks.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module BourbonIntegrator
+  module Tasks
+    class << self
+      attr_reader :config
+    end
+
+    def self.load(config)
+      @config = config
+      tasks_path = File.join(File.dirname(__FILE__), "tasks")
+      Dir["#{tasks_path}/*.rake"].each { |ext| ::Kernel.load(ext, true) } if defined?(::Rake)
+    end
+  end
+end

data/lib/bourbon_integrator/version.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module BourbonIntegrator
+  VERSION = "1.0.0".freeze
+end

data/lib/bourbon_integrator.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of BourbonIntegrator.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "bourbon_integrator/version"
+require "bourbon_integrator/config"
+require "bourbon_integrator/tasks"