heartwood 0.0.1

data/lib/generators/cambium/gemfile_generator.rb

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rails/generators'
+
+module Heartwood
+  class GemfileGenerator < Rails::Generators::Base
+
+    desc "Replace your existing Gemfile with Heartwood's default Gemfile."
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    # Here we figure out some of the more complicated logic
+    # before rendering the Gemfile template
+    #
+    def resolve_options
+      @rails_version = `bundle exec rails -v`.to_s.split(' ').last
+    end
+
+    # Move our default Gemfile to the project's Gemfile.
+    #
+    def add_config_file
+      template "Gemfile.erb", "Gemfile", :force => true
+      gsub_file "Gemfile", /\n\n\n+?/, "\n\n"
+    end
+
+    private
+
+      def gem_root
+        Gem::Specification.find_by_name("heartwood").gem_dir
+      end
+
+      def help_message(file)
+        puts File.read("#{gem_root}/lib/help/#{file}.txt")
+      end
+
+  end
+end

data/lib/generators/cambium/install_generator.rb

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rails/generators'
+
+module Heartwood
+  class InstallGenerator < Rails::Generators::Base
+    desc "Add Heartwood config file to your initializers."
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    # Copy our Heartwood config file into the project's
+    # config/initializers directory.
+    #
+    def add_config_file
+      config_file = "config/initializers/heartwood.rb"
+      copy_file config_file, config_file
+    end
+
+  end
+end

data/lib/generators/cambium/user_generator.rb

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rails/generators'
+
+module Heartwood
+  class UserGenerator < Rails::Generators::Base
+
+    desc "Create a new user for your app."
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    class_option(
+      :admin,
+      :type => :boolean,
+      :default => false,
+      :description => "Make the user an admin"
+    )
+
+    argument :email, :type => :string
+    argument :password, :type => :string
+
+    # Create a user with the provided credentials
+    def create_user
+      if options.admin == true
+        User.create!(
+          :email => email,
+          :password => password,
+          :password_confirmation => password,
+          :is_admin => options.admin
+        )
+      else
+        User.create!(
+          :email => email,
+          :password => password,
+          :password_confirmation => password
+        )
+      end
+    end
+
+  end
+end

data/lib/generators/helpers/_autoloader.rb

@@ -0,0 +1,12 @@
+Dir.glob(File.expand_path('../../helpers/**/*.rb', __FILE__)).each do |file|
+  unless file == __FILE__
+    require file
+    module_name = []
+    File.read(file).each_line do |line|
+      if line =~ /module\ /
+        module_name << line.gsub(/module\ /, '').strip
+      end
+    end
+    include module_name.join('::').constantize
+  end
+end

data/lib/generators/helpers/generators_helper.rb

@@ -0,0 +1,235 @@
+module Heartwood
+  module GeneratorsHelper
+
+    # ------------------------------------------ System Commands / Aliases
+
+    # Shorthand for `bundle exec`
+    #
+    def be
+      "bundle exec"
+    end
+
+    # Runs a system command, but with pretty output
+    #
+    def run_cmd(cmd, options = {})
+      print_table(
+        [
+          [set_color("run", :green, :bold), cmd]
+        ],
+        :indent => 9
+      )
+      if options[:quiet] == true
+        `#{cmd}`
+      else
+        system(cmd)
+      end
+    end
+
+    # Make sure we get a matching answer before moving on. Useful for usernames,
+    # passwords, and other items where user error is harmful (or painful)
+    #
+    def confirm_ask(question)
+      answer = ask("\n#{question}")
+      match = ask("CONFIRM #{question}")
+      if answer == match
+        answer
+      else
+        say set_color("Did not match.", :red)
+        confirm_ask(question)
+      end
+    end
+
+    # Run rake db:migrate
+    #
+    def migrate
+      rake "db:migrate"
+    end
+
+    # Annotate our models and tests
+    #
+    def annotate
+      # need to make sure we have the annotate gem to avoid errors
+      install_gem('annotate')
+      run_cmd "#{be} annotate"
+    end
+
+    # Run migrate and annotate
+    #
+    def migrate_and_annotate
+      migrate
+      annotate
+    end
+
+    # ------------------------------------------ Templating
+
+    # Copy template file to project unless it's already there
+    #
+    def copy_unless_exists(path, new_path = path)
+      copy_file(path, new_path) unless File.exists?("#{Rails.root}/#{new_path}")
+    end
+
+    def copy_files(files, dir)
+      files.each { |f| copy_unless_exists("#{dir}/#{f}") }
+    end
+
+    # Get the path to a particular template
+    #
+    def template_file(name)
+      File.expand_path("../../templates/#{name}", __FILE__)
+    end
+
+    # Partial template path are for templates that aren't the entire file to be
+    # copied.
+    #
+    def template_partial_path(name)
+      File.expand_path("../../templates/_partials/#{name}", __FILE__)
+    end
+
+    # Read a template and return its contents
+    #
+    def file_contents(template)
+      File.read(template_file(template))
+    end
+
+    def template_snippet(template)
+      require 'erb'
+      ERB.new(File.read(template_file(template))).result(binding)
+    end
+
+    # Copies model concern templates to the project
+    #
+    def add_model_concern(name)
+      copy_unless_exists "app/models/concerns/#{name}.rb"
+    end
+
+    # Alias for previous method
+    #
+    def model_concern(name)
+      add_model_concern(name)
+    end
+
+    # Add multiple concerns
+    #
+    def add_model_concerns(concerns)
+      concerns.each { |c| add_model_concern(c) }
+    end
+
+    # Copy multiple directories
+    #
+    def directories(dir_arr, container)
+      dir_arr.each do |dir|
+        directory "#{container}/#{dir}", "#{container}/#{dir}"
+      end
+    end
+
+    # ------------------------------------------ Gems
+
+    # Run `bundle install`
+    #
+    def bundle
+      run_cmd "bundle install"
+      run_cmd "bundle clean"
+    end
+
+    # Get the local path where the gems are installed
+    #
+    def gem_dir
+      gem_dir = `bundle show rails`
+      gem_dir = gem_dir.split('/')
+      gem_dir[0..-3].join('/')
+    end
+
+    # Add gem to Gemfile
+    #
+    def add_to_gemfile(name, options = {})
+      unless gem_exists?(name)
+        if options[:require].present?
+          text = "\n\ngem '#{name}', :require => '#{options[:require]}'"
+        else
+          text = "\n\ngem '#{name}'"
+        end
+        insert_into_file "Gemfile", text, :after => "rubygems.org'"
+      end
+    end
+
+    # Add several gems to the gemfile
+    def add_gems_to_gemfile(gems)
+      gems.each { |g| add_to_gemfile(g) }
+    end
+
+    # Find if a gem exists
+    #
+    def gem_exists?(name)
+      Gem::Specification::find_all_by_name(name).any?
+    end
+
+    # First, install the gem in the local gem directory, then add it to the
+    # Gemfile (if it doesn't already exist).
+    #
+    # Note: This will run bundle install after adding the gem, unless specified
+    # otherwise.
+    #
+    def install_gem(name, options = {})
+      if gem_exists?(name)
+        say "Found existing gem: #{name}"
+      else
+        run "gem install #{name} -i #{gem_dir}"
+        add_to_gemfile(name, options)
+        bundle if options[:bundle].nil? || options[:bundle] == true
+      end
+    end
+
+    # Install an array of gems -- useful if needing to install more than one
+    # gem.
+    #
+    def install_gems(gem_arr)
+      gem_arr.each { |gem_name| install_gem(gem_name, :bundle => false) }
+      bundle
+    end
+
+    # Notifies the user of the gems that were installed and how desperately
+    # important they are.
+    #
+    def gem_installation_notification(gems)
+      say "\nThis generator installed the following gems (and added them to "
+      say "your Gemfile):\n\n"
+      gems.each { |g| say "    #{g}" }
+      say "\nThese gems *may* be necessary for Heartwood to work properly. "
+    end
+
+    # Similar to gem_installation_notification, except here we just tell the
+    # user we added gems to the gemfile and they will have to bundle
+    #
+    def gemfile_update_notification(gems)
+      say "\nThis generator added some gems to your Gemfile. You will want to "
+      say "run:\n\n    $ bundle install"
+      say "\nto complete this generator. Please note, "
+      say "these gems *may* be necessary for Heartwood to work properly."
+    end
+
+    # ------------------------------------------ Miscellaneous
+
+    # Return current time in migration timestamp format
+    #
+    def timestamp
+      Time.now.gmtime.strftime('%Y%m%d%H%M%S')
+    end
+
+    # Check to see if a class exists. This can be helpful in determining if
+    # other generators have been run.
+    #
+    def class_exists?(class_name)
+      klass = Module.const_get(class_name)
+      klass.is_a?(Class)
+    end
+
+    def gem_root
+      Gem::Specification.find_by_name("heartwood").gem_dir
+    end
+
+    def help_message(file)
+      puts File.read("#{gem_root}/lib/help/#{file}.txt")
+    end
+
+  end
+end

data/lib/generators/templates/Gemfile.erb

@@ -0,0 +1,78 @@
+source 'https://rubygems.org'
+
+# ------------------------------------------ Base
+
+# rails version
+gem 'rails', '<%= @rails_version %>'
+
+# app server
+gem 'unicorn-rails'
+
+# database adapter
+gem 'pg'
+
+# ------------------------------------------ Assets
+
+# stylesheets helpers
+gem 'sass-rails'
+gem 'compass-rails'
+gem 'bourbon'
+gem 'bones-rails'
+
+# javascripts helpers
+gem 'uglifier'
+gem 'coffee-rails'
+gem 'jquery-rails'
+gem 'backbone-on-rails'
+
+# ------------------------------------------ View Helpers
+
+gem 'simple_form'
+gem 'jbuilder'
+gem 'pickadate-rails'
+gem 'kaminari'
+
+# ------------------------------------------ File Uploads
+
+gem 'dragonfly'
+gem 'jquery-fileupload-rails'
+gem 'jcrop-rails-v2'
+
+# ------------------------------------------ Utilities
+
+gem 'devise'
+gem 'heartwood'
+gem 'paper_trail'
+gem 'pg_search'
+
+# ------------------------------------------ Console Helpers
+
+gem 'rails-console-tweaks'
+
+group :console do
+  gem 'wirb'
+  gem 'hirb'
+  gem 'awesome_print'
+end
+
+# ------------------------------------------ Error Handling
+
+group :development do
+  gem 'better_errors'
+  gem 'binding_of_caller'
+end
+
+# ------------------------------------------ Performance
+
+group :production do
+  gem 'rack-cache', :require => 'rack/cache'
+end
+
+# ------------------------------------------ Testing
+
+group :development, :test do
+  gem 'annotate'
+  gem 'factory_girl_rails'
+  gem 'faker'
+  gem 'rspec-rails'
+end

data/lib/generators/templates/app/assets/javascripts/application.js.coffee

@@ -0,0 +1,24 @@
+#= require jquery
+#= require jquery_ujs
+#= require underscore
+#= require backbone
+#= require_self
+#= require_tree ./templates
+#= require_tree ./views
+#= require_tree ./routers
+
+window.App =
+  Collections: {}
+  Routers: {}
+  Views: {}
+
+$ ->
+  new App.Routers.Router
+
+  # Enable pushState for compatible browsers
+  enablePushState = true
+
+  # Disable for older browsers
+  pushState = !!(enablePushState && window.history && window.history.pushState)
+
+  Backbone.history.start({ pushState: pushState })

data/lib/generators/templates/app/assets/javascripts/routers/router.js.coffee

@@ -0,0 +1,23 @@
+class App.Routers.Router extends Backbone.Router
+
+  initialize: =>
+    @autoLoadClass()
+
+  autoLoadClass: =>
+    # This is a good place to automatically load classes that may be dependent
+    # on a page element, and not necessarily the route.
+    #
+    # For example:
+    #
+    # new App.Views.Nav if $('.main-nav').length > 0
+    #
+    # Or, perhaps you need to load a class on every page. Do that, here, too,
+    # like this:
+    #
+    new App.Views.DefaultHelpers
+
+  routes:
+    '': 'initHomePage'
+
+  initHomePage: ->
+    console.log "Welcome to this awesome site, built using Heartwood!"

data/lib/generators/templates/app/assets/javascripts/views/default_helpers.js.coffee

@@ -0,0 +1,16 @@
+class App.Views.DefaultHelpers extends Backbone.View
+
+  el: 'body'
+
+  initialize: =>
+    @disabledLinks()
+    @fadeOutNotices()
+
+  disabledLinks: =>
+    $('a.disabled').click (e) ->
+      e.preventDefault()
+
+  fadeOutNotices: =>
+    setTimeout () =>
+      $('.notice, .alert').fadeOut()
+    , 3500

data/lib/generators/templates/app/assets/stylesheets/admin/admin.scss

@@ -0,0 +1,3 @@
+// This is the file you may use to override (or add to)
+// Heartwood styles. You may also use this file as a manifest
+// file if you wish to break out your custom styles.

data/lib/generators/templates/app/assets/stylesheets/application.scss

@@ -0,0 +1,9 @@
+
+// ------------------------------------------ Vendor
+
+@import 'bourbon';
+@import 'normalize';
+
+// ------------------------------------------ Partials
+
+// @import 'partials/globals';

data/lib/generators/templates/app/controllers/admin/controller.rb.erb

@@ -0,0 +1,2 @@
+class Admin::<%= @model.to_s.pluralize %>Controller < Heartwood::AdminController
+end

data/lib/generators/templates/app/controllers/application_controller.rb

@@ -0,0 +1,11 @@
+
+
+  # redirect to admin dashboard after signing in
+  def after_sign_in_path_for(user)
+    super
+  end
+
+  # redirect back to sign in form when signed out
+  def after_sign_out_path_for(user)
+    root_path
+  end

data/lib/generators/templates/app/models/user.rb

@@ -0,0 +1,14 @@
+class User < ActiveRecord::Base
+
+  # ------------------------------------------ Devise
+
+  # Include default devise modules. Others available are:
+  # :lockable, :timeoutable, :omniauthable, :confirmable, :registerable
+  devise :database_authenticatable, :recoverable, :rememberable, :trackable,
+         :validatable
+
+  def to_s
+    email
+  end
+
+end

data/lib/generators/templates/app/views/application/_status.html.erb

@@ -0,0 +1,3 @@
+<% flash.each do |lvl, msg| %>
+  <%= content_tag(:p, msg, :class => lvl) %>
+<% end %>

data/lib/generators/templates/app/views/home/index.html.erb

@@ -0,0 +1,7 @@
+<h1>Hello!</h1>
+
+<p>I am your home page, generated by Heartwood.</p>
+
+<p>You should edit me, otherwise you're site will be kind of boring.</p>
+
+<p>Can't find me? I'm in <code>app/views/home/index.html.erb</code></p>

data/lib/generators/templates/app/views/layouts/application.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html class="public">
+  <head>
+    <title><%= @config.app_title %></title>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <!-- <meta name="description" content="<%%#= @meta[:description] %>"> -->
+    <!-- <meta name="robots" content="noindex, nofollow"> -->
+    <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0, initial-scale=1.0">
+    <meta name="apple-mobile-web-app-capable" content="yes">
+    <meta name="format-detection" content="telephone=no">
+    <%%= stylesheet_link_tag 'application', :media => 'all' %>
+    <%%= javascript_include_tag "modernizr" %>
+    <%%= csrf_meta_tags %>
+  </head>
+  <body>
+
+    <%%= render :partial => 'status' %>
+
+    <%%= yield %>
+
+    <%%= javascript_include_tag 'application' %>
+  </body>
+</html>

data/lib/generators/templates/config/application.rb

@@ -0,0 +1,17 @@
+
+    config.generators do |g|
+      g.fixture true
+      g.fixture_replacement "factory_girl"
+      g.test_framework :rspec
+      g.assets false
+      g.view_specs false
+      g.model_specs false
+      g.controller_specs false
+      g.helper_specs false
+      g.routing_specs false
+      g.request_specs false
+      g.stylesheets false
+      g.javascripts false
+      g.helper false
+      g.skip_routes true
+    end

data/lib/generators/templates/config/initializers/_hash.rb

@@ -0,0 +1,23 @@
+class Hash
+
+  def to_ostruct
+    convert_to_ostruct_recursive(self)
+  end
+
+  private
+
+    def convert_to_ostruct_recursive(obj)
+      result = obj
+      if result.is_a? Hash
+        result = result.dup.symbolize_keys
+        result.each  do |key, val|
+          result[key] = convert_to_ostruct_recursive(val)
+        end
+        result = OpenStruct.new(result)
+      elsif result.is_a? Array
+        result = result.map { |r| convert_to_ostruct_recursive(r) }
+      end
+      result
+    end
+
+end

data/lib/generators/templates/config/initializers/_settings.rb

@@ -0,0 +1,18 @@
+# Load config/settings.yml into Settings OpenStruct
+#
+begin
+  config_file = File.join(Rails.root,'config','settings.yml')
+  Settings = YAML.load_file(config_file)[Rails.env].to_ostruct
+rescue
+  raise "Can't find file: #{config_file}"
+end
+
+# Loads config/private.yml (sensitive settings) into Private
+# OpenStruct
+#
+begin
+  private_file = File.join(Rails.root,'config','private.yml')
+  Private = YAML.load_file(private_file)[Rails.env].to_ostruct
+rescue
+  raise "Can't find file: #{private_file}"
+end

data/lib/generators/templates/config/initializers/assets.rb

@@ -0,0 +1,3 @@
+Rails.application.config.assets.precompile += %w(
+  modernizr.js trumbowyg/images/icons.png trumbowyg/images/icons-2x.png
+  trumbowyg/images/icons.svg)

data/lib/generators/templates/config/initializers/heartwood.rb

@@ -0,0 +1,25 @@
+Heartwood.configure do |config|
+
+  # -------------------------------------------------- App Info
+
+  # Heartwood uses these to set your root urls for
+  # mailers and other fun stuff.
+  #
+  config.development_url = 'localhost:3000'
+  config.production_url = 'example.com'
+
+  # The title of your app is what Heartwood puts in the
+  # browser tab by default.
+  #
+  config.app_title = 'Heartwood'
+
+  # -------------------------------------------------- Caching
+
+  # Heartwood's Pages come with action caching support. It is disabled by default.
+  # Uncomment the setting below to enable action caching.
+  #
+  # NOTE: You must install the 'actionpack-action_caching' gem for this to work.
+  #
+  # config.cache_pages = true
+
+end

data/lib/generators/templates/config/private.yml

@@ -0,0 +1,16 @@
+# This file is for storing SENSITIVE settings. This file is
+# not tracked.
+#
+# Values here are accessible through a recursive `Private`
+# OpenStruct. For example, you can access "ABC123" using the
+# example below through Private.my_group.my_special_key
+#
+development: &default
+  my_group:
+    my_special_key: "ABC123"
+
+test:
+  <<: *default
+
+production:
+  <<: *default