hibachi 0.0.1.pre

data/lib/hibachi/persistence.rb

@@ -0,0 +1,76 @@
+module Hibachi
+  # Backend data store methods for the Hibachi::Model
+  module Store
+    extend ActiveSupport::Concern
+
+    # Merge attrs and write to JSON.
+    def save
+      persist and chef
+    end
+
+    # Update an existing model's attributes.
+    def update_attributes(attrs={})
+      merge(attrs) and save
+    end
+
+    # Remove the given id from the JSON and re-run Chef.
+    def destroy
+      clear and chef
+    end
+
+    # Test if this model appears in the Node JSON.
+    def persisted?
+      if collection?
+        node[recipe][id].present?
+      else
+        node[recipe].present?
+      end
+    end
+
+    # Returns `true` if it's not currently being persisted.
+    def new_record?
+      (not persisted?)
+    end
+
+    private
+    def merge(new_attrs={})
+      @attributes = @attributes.merge new_attrs
+      attributes.each do |key, value|
+        setter = "#{key}="
+        send setter, value if respond_to? setter
+      end
+    end
+
+    def persist
+      @persisted ||= if new_record?
+        create
+      else
+        update
+      end
+    end
+
+    def create
+      node.merge! recipe => new_recipe_attributes
+    end
+
+    def update
+      node.merge! recipe_name => new_recipe_attributes
+    end
+
+    def new_recipe_attributes
+      if singleton?
+        node[recipe].merge attributes
+      else
+        node[recipe].merge id => attributes
+      end
+    end
+
+    def clear
+      if singleton?
+        node.delete!
+      else
+        node.delete id
+      end
+    end
+  end
+end

data/lib/hibachi/provisioning.rb

@@ -0,0 +1,28 @@
+module Hibachi
+  # Code for provisioning the box.
+  module Provisioning
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Accessor for the global Chef JSON.
+      def node
+        @node ||= Node.new(file_path: Hibachi.config.chef_json_path)
+      end
+    end
+
+    # Accessor for the global Chef JSON in an instance.
+    def node
+      self.class.node
+    end
+
+    # Run chef for the given recipe.
+    def chef
+      Hibachi.run_chef recipe, background: run_in_background?
+    end
+
+    private
+    def run_in_background?
+      Hibachi.config.run_in_background
+    end
+  end
+end

data/lib/hibachi/querying.rb

@@ -0,0 +1,48 @@
+module Hibachi
+  module Querying
+    # Write the given attrs to config and re-run Chef.
+    def create from_attributes={}
+      model = new from_attributes
+      model.save
+      model
+    end
+
+    # Find everything from the JSON.
+    def all
+      return fetch if singleton?
+      node[recipe_name].map { |from_params| new from_params }
+    end
+
+    # Find all objects of this type matching the given search
+    # criteria. Uses the all() method to scope calls from within the
+    # proper JSON for this class, and instantiates objects based on
+    # the found information, so you get back an Array of whatever
+    # object this model happens to be. If none, this returns an empty
+    # Array.
+    def where has_attributes={}
+      return fetch if singleton?
+      all.select { |persisted_attr, persisted_val|
+        has_attributes.any? { |search_attr, search_val|
+          persisted_attr == search_attr && persisted_val == search_val
+        }
+      }.map { |from_params|
+        new from_params
+      }
+    end
+
+    # Find a given model by name, or return `nil`. Aliases to `fetch` if
+    # this model is a singleton.
+    def find by_name=""
+      return fetch if singleton?
+      where(name: by_name).first
+    end
+
+    # Use all the attributes in this recipe to deploy the model if this
+    # is a Singleton.
+    def fetch
+      model = new node[recipe_name]
+      model.valid?
+      model
+    end
+  end
+end

data/lib/hibachi/railtie.rb

@@ -0,0 +1,24 @@
+require 'rails/railtie'
+
+module Hibachi
+  # Default Rails config for the engine.
+  class Railtie < Rails::Railtie
+    config.hibachi = ActiveSupport::OrderedOptions.new
+
+    # Configure where the Chef JSON will be stored, by default it's
+    # located in the Rails config dir.
+    config.hibachi.chef_json_path = "#{Rails.root}/config/chef.json"
+
+    # Configure where to look for the Chef repo.
+    config.hibachi.chef_dir = "#{Rails.root}/config/chef"
+
+    # Configure where the log file will be kept of all Chef runs, by
+    # default it's located in the Rails log dir.
+    config.hibachi.log_path = "#{Rails.root}/log/hibachi.log"
+
+    # If you're using ActiveJob, Hibachi can trigger Chef runs to queue
+    # in the background. Just flip this flag to `true` and get
+    # backgrounding for free.
+    config.hibachi.run_in_background = false
+  end
+end

data/lib/hibachi/recipe.rb

@@ -0,0 +1,48 @@
+module Hibachi
+  # Methods for manipulating and reading the recipe of the model class,
+  # as well as defining whether this recipe is a singleton or
+  # collection.
+  module Recipe
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      cattr_accessor :recipe_name, :recipe_type
+
+      # Set the recipe on this model. You can feel free to omit the
+      # '::default', but if you have a '::' in there the code will not
+      # touch this name. By default, this creates a 'collection' recipe.
+      def recipe name, options={}
+        self.recipe_name = name
+        from_opts = "#{options[:type]}" || 'collection'
+        self.recipe_type = ActiveSupport::StringInquirer.new from_opts
+      end
+
+      # An alias for `recipe` to give parity to `singleton_recipe`.
+      alias collection_recipe recipe
+
+      # Shorthand for creating a 'singleton' recipe, you can also simply
+      # pass :type => :singleton in the `recipe` call.
+      def singleton_recipe name
+        recipe name, :type => :singleton
+      end
+
+      delegate :collection?, :to => :recipe_type
+      delegate :singleton?, :to => :recipe_type
+    end
+
+    # Return the recipe name as set in the class definition.
+    def recipe
+      self.class.recipe_name
+    end
+
+    # Return the recipe type as set in the class definition. It's a
+    # StringInquirer, so it defines methods that allow us to test
+    # whether this is a `collection?` or a `singleton?`.
+    def type
+      self.class.recipe_type
+    end
+
+    delegate :collection?, :to => :type
+    delegate :singleton?, :to => :type
+  end
+end

data/lib/hibachi/version.rb

@@ -0,0 +1,3 @@
+module Hibachi
+  VERSION = "0.0.1.pre"
+end

data/lib/hibachi.rb

@@ -0,0 +1,9 @@
+require 'hibachi/version'
+require 'hibachi/configuration'
+require 'hibachi/chef_runner'
+require 'hibachi/model'
+
+module Hibachi
+  extend ChefRunner
+  extend Configuration
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, 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_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "hibachi"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+    config.hibachi.chef_json_path = File.expand_path('../../../fixtures/chef.json', __FILE__)
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,13 @@
+default: &default
+  adapter: sqlite3
+  encoding: unicode
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+test:
+  <<: *default
+  database: db/test.sqlite3
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,83 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy/config/hibachi.rb

@@ -0,0 +1,6 @@
+require 'hibachi'
+
+Hibachi.configure do |config|
+  config.chef_json_path = "#{Rails.root}/config/chef.json"
+  config.log_file_path = "#{Rails.root}/log/chef.log"
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end