alchemy-site_bootstrapping 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c877581e94b040cacb9e39a21023f9d47f904fc1
+  data.tar.gz: eee53de1a5288ff8b146462fad1cc092f9aa7eed
+SHA512:
+  metadata.gz: 0643f4c2d1e79d1852b091662d12701546d8818fadd5d1e80ae37ebc0521984330ac65ea37d6c97c5b2ee584e23f0808d00c3474c850230d14a1701cf971d706
+  data.tar.gz: 7d2c3fe0b92ced4b41ae4f1ec98de4620211369c1a75152f110724186fc0f4823eb85b9378fd7657ac78627dbbe6c72601940dc23af093f347d029a96f6932e6

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.bundle/
+log/*.log
+pkg/

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in alchemy-site_bootstrapping.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    alchemy-site_bootstrapping (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (11.1.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  alchemy-site_bootstrapping!
+  bundler (~> 1.3)
+  rake
+  rspec (~> 2.14)
+
+BUNDLED WITH
+   1.11.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Robin Böning
+
+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,41 @@
+# Bootstrap your Alchemy sites
+
+This gem allows you to use different stylesheets and javascripts for each of your alchemy sites.
+
+If you are running a multi-site environment with Alchemy CMS and you want to make those sites look and bwehave different from each other, this gem is a good fit for you.
+
+# How to use the gem
+
+1. The gem provides a site generator which creates the site in your database and also generates the manifest files for the site specific stylesheets and javascripts.
+
+Create a new site
+
+```
+$ rails g alchemy:site blog localhost
+```
+
+The generator will create a new site called blog that runs on localhost.
+
+It also creates a CSS manifest file `app/assets/stylesheets/blog.scss`. By default this file imports all files from `app/assets/stylesheets/alchemy/sites/blog/` folder and will be considered to be precompiled in production.
+
+It also creates a Javascript manifest file `app/assets/javascripts/blog.js`. By default this file requires all files from `app/assets/javascripts/alchemy/sites/blog/` folder and will be considered to be precompiled in production.
+
+
+2. The gem also provides view helpers to render the right stylesheet or javascript in your layout. If for whatever reason it can not find the right file it will fall back to `application.js/css`.
+
+
+To render site specific stylesheets simply pass `stylesheet_for_current_site`  to `stylesheet_link_tag`.
+
+```
+<%= stylesheet_link_tag stylesheet_for_current_site, media: 'all' %>
+```
+
+To render site specific javascripts simply pass `javascript_for_current_site` to `javascript_include_tag`.
+
+```
+<%= javascript_include_tag javascript_for_current_site %>
+```
+
+## 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,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Alchemy::SiteBootstrapping'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/alchemy_site_bootstrapping.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alchemy/site_bootstrapping/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alchemy-site_bootstrapping"
+  spec.version       = Alchemy::SiteBootstrapping::VERSION
+  spec.authors       = ["Robin Böning"]
+  spec.email         = ["robin.boening@bitspire.de"]
+  spec.description   = %q{Bootstrap your Alchemy sites}
+  spec.summary       = %q{Bootstrap your Alchemy sites}
+  spec.homepage      = "https://bitspire.de"
+  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"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/bin/test

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$: << File.expand_path(File.expand_path('../../test', __FILE__))
+
+require 'bundler/setup'
+require 'rails/test_unit/minitest_plugin'
+
+Rails::TestUnitReporter.executable = 'bin/test'
+
+exit Minitest.run(ARGV)

data/lib/alchemy/site_bootstrapping.rb

@@ -0,0 +1,7 @@
+require "alchemy/site_bootstrapping/view_helpers"
+require "alchemy/site_bootstrapping/engine"
+
+module Alchemy
+  module SiteBootstrapping
+  end
+end

data/lib/alchemy/site_bootstrapping/engine.rb

@@ -0,0 +1,39 @@
+module Alchemy
+  module SiteBootstrapping
+
+    class Engine < Rails::Engine
+
+      # Collecting stylesheets in app/assets/stylesheets
+      initializer "alchemy.assign_stylesheets_for_sites" do |app|
+        app.config.stylesheets_for_alchemy_sites =
+          Dir.glob(File.join(Rails.root, "app/assets/stylesheets/*.scss"))
+      end
+
+      # Stylesheets defined for Sites will be precompiled.
+      initializer 'alchemy.stylesheets_for_sites_to_precompile' do |app|
+        app.config.stylesheets_for_alchemy_sites.each do |file_path|
+          app.config.assets.precompile << "#{File.basename(file_path, '.scss')}.css"
+        end
+      end
+
+      # Collecting javascripts in app/assets/javascripts
+      initializer "alchemy.assign_javascripts_for_sites" do |app|
+        app.config.javascripts_for_alchemy_sites =
+          Dir.glob(File.join(Rails.root, "app/assets/javascripts/*.js"))
+      end
+
+      # Javascripts defined for Sites will be precompiled.
+      initializer 'alchemy.javascripts_for_sites_to_precompile' do |app|
+        app.config.javascripts_for_alchemy_sites.each do |file_path|
+          app.config.assets.precompile << "#{File.basename(file_path, '.js')}.js"
+        end
+      end
+
+      # Make helper methods available to use correct stylesheet for each particular site
+      initializer "alchemy.sitebootstrapping.view_helpers" do
+        ActionView::Base.send :include, ViewHelpers
+      end
+    end
+
+  end
+end

data/lib/alchemy/site_bootstrapping/version.rb

@@ -0,0 +1,5 @@
+module Alchemy
+  module SiteBootstrapping
+    VERSION = '0.1.0'
+  end
+end

data/lib/alchemy/site_bootstrapping/view_helpers.rb

@@ -0,0 +1,36 @@
+module Alchemy
+  module SiteBootstrapping
+    module ViewHelpers
+
+      # In your layout file use this view helper to render the stylesheet for the currently requested site
+      # Usage: `stylesheet_link_tag stylesheet_for_current_site, media: 'all'`
+      def stylesheet_for_current_site
+        site_has_stylesheet?(current_site_name) ? current_site_name.parameterize : "application"
+      end
+
+      def site_has_stylesheet?(site_name)
+        stylesheets = Rails.application.config.stylesheets_for_alchemy_sites
+        stylesheets.map { |f| File.basename(f) }.include? "#{site_name.parameterize}.scss"
+      end
+
+      # In your layout file use this view helper to render the javascript for the currently requested site
+      # Usage: `javascript_include_tag javascript_include_tag`
+      def javascript_for_current_site
+        site_has_javascript?(current_site_name) ? current_site_name.parameterize : "application"
+      end
+
+      def site_has_javascript?(site_name)
+        javascripts = Rails.application.config.javascripts_for_alchemy_sites
+        javascripts.map { |f| File.basename(f) }.include? "#{site_name.parameterize}.js"
+      end
+
+      def current_site_name
+        @current_site_name ||= Alchemy::Site.current.name
+      end
+
+      def favicon_path(filename)
+        asset_path "favicon/#{current_site_name.parameterize}/#{filename}"
+      end
+    end
+  end
+end

data/lib/rails/generators/alchemy/site/site_generator.rb

@@ -0,0 +1,45 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class SiteGenerator < ::Rails::Generators::Base
+      desc "This generator generates your site and its corresponding asset structure."
+      argument :site_name, banner: "Site-Name"
+      argument :site_host, banner: "site-host.com"
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      def init
+        @site_name = site_name
+        @parameterized_site_name = site_name.parameterize
+        @site_host = site_host
+      end
+
+      def create_site
+        site = Alchemy::Site.find_or_initialize_by(name: @site_name, host: @site_host)
+        if site.persisted?
+          puts "Site #{@site_name} already exists. Skipping creation of Site."
+        else
+          site.save!
+          puts "Created Site #{@site_name} (unpublished)."
+        end
+      end
+
+      def create_stylesheets
+        puts "Creating directories and files for site related stylesheets..."
+        root_css_dir = "#{Rails.root}/app/assets/stylesheets"
+        namespaced_site_dir = "#{root_css_dir}/alchemy/sites/#{@parameterized_site_name}"
+        empty_directory namespaced_site_dir
+        template "site.scss", "#{root_css_dir}/#{@parameterized_site_name}.scss"
+        template "_variables.scss", "#{namespaced_site_dir}/_variables.scss"
+      end
+
+      def create_javascripts
+        puts "Creating directories and files for site related javascripts..."
+        root_js_dir = "#{Rails.root}/app/assets/javascripts"
+        empty_directory "#{root_js_dir}/alchemy/sites/#{@parameterized_site_name}"
+        template "site.js", "#{root_js_dir}/#{@parameterized_site_name}.js"
+      end
+
+    end
+  end
+end

data/lib/rails/generators/alchemy/site/templates/_variables.scss

@@ -0,0 +1 @@
+// Add <%= @site_name %> specific variables here

data/lib/rails/generators/alchemy/site/templates/site.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into <%= @parameterized_site_name %>.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree ./alchemy/sites/<%= @parameterized_site_name %>

data/lib/rails/generators/alchemy/site/templates/site.scss

@@ -0,0 +1,34 @@
+/*
+ * This is a manifest file that'll be compiled into <%= @parameterized_site_name %>.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_self
+ */
+
+// This file was created by a generator provided by the alchemy-site_bootstrapping gem.
+
+// // From our best practise: Site specific variables for <%= @site_name %>
+@import "alchemy/sites/<%= @parameterized_site_name %>/variables";
+
+// From our best practise: All global settings and default variables
+// @import "global/settings";
+
+// <%= @site_name %> fonts
+// @import "alchemy/sites/<%= @parameterized_site_name %>/fonts";
+
+// From our best practise: All other global styles
+// @import "global/*";
+
+// Styling for Alchemy elements
+// @import "alchemy/elements/*";
+
+// <%= @site_name %> specific styles
+// @import "alchemy/sites/<%= @parameterized_site_name %>/*";

data/lib/tasks/alchemy/site_bootstrapping_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :alchemy_site_bootstrapping do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: alchemy-site_bootstrapping
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robin Böning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Bootstrap your Alchemy sites
+email:
+- robin.boening@bitspire.de
+executables:
+- test
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- alchemy_site_bootstrapping.gemspec
+- bin/test
+- lib/alchemy/site_bootstrapping.rb
+- lib/alchemy/site_bootstrapping/engine.rb
+- lib/alchemy/site_bootstrapping/version.rb
+- lib/alchemy/site_bootstrapping/view_helpers.rb
+- lib/rails/generators/alchemy/site/site_generator.rb
+- lib/rails/generators/alchemy/site/templates/_variables.scss
+- lib/rails/generators/alchemy/site/templates/site.js
+- lib/rails/generators/alchemy/site/templates/site.scss
+- lib/tasks/alchemy/site_bootstrapping_tasks.rake
+homepage: https://bitspire.de
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Bootstrap your Alchemy sites
+test_files: []