cookbook 0.1.0

data/db/migrate/20210909141929_create_uses.cookbook.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Uses acts as a polymorphic joining table with extras for context
+# For example, a Recipe might "use" Tools, Supplies, and Ingredients.
+class CreateUses < ActiveRecord::Migration[6.1]
+  def change
+    create_table :cookbook_uses do |t|
+      t.boolean :published, default: true
+      t.references :use_in, polymorphic: true, null: false
+      t.references :use_of, polymorphic: true, null: false
+      t.float :quantity_minimum
+      t.float :quantity_maximum
+      t.string :unit
+      t.integer :sort
+      t.string :note
+      t.string :preparation
+
+      t.timestamps
+    end
+  end
+end

data/lib/cookbook/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Cookbook Module
+module Cookbook
+  class << self
+    def configure(configuration = Cookbook::Configuration.new)
+      block_given? && yield(configuration)
+      @configuration = configuration
+    end
+
+    def configuration
+      @configuration ||= Cookbook::Configuration.new
+    end
+  end
+
+  # Cookbook Configuration
+  class Configuration
+    attr_accessor(
+      :include_cookbook_css,
+      :authorize_with
+    )
+
+    def initialize
+      self.include_cookbook_css = false
+      self.authorize_with = nil
+    end
+  end
+end

data/lib/cookbook/engine.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Cookbook
+  # Cookbook Engine
+  class Engine < Rails::Engine
+    isolate_namespace Cookbook
+    engine_name 'cookbook'
+
+    initializer 'local_helper.action_controller' do
+      ActiveSupport.on_load :action_controller do
+        helper Cookbook::ApplicationHelper
+      end
+    end
+    initializer 'cookbook.assets.precompile' do |app|
+      app.config.assets.precompile += %w[cookbook/application.css cookbook/application.js vanilla_nested.js]
+    end
+
+    config.generators do |g|
+      g.hidden_namespaces << 'test_unit' << 'erb'
+      g.orm             :active_record
+      g.template_engine :haml
+      g.test_framework  :rspec, fixture: false
+      g.integration_tool :rspec
+      g.stylesheets     false
+      g.javascripts     false
+      g.view_specs      false
+      g.helper_specs    false
+    end
+
+    def self.table_name_prefix
+      'cookbook_'
+    end
+  end
+end

data/lib/cookbook/extensions/float.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+# Give Floats the ability to display with human-readable precision
+class Float
+  def format_quantity
+    to_s.sub(/\.?0+$/, '')
+  end
+end

data/lib/cookbook/mixins/acts_as_use_of.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Cookbook
+  module Mixins
+    # ActsAsUseIn Mixin, for things like Recipes or HowTos
+    module ActsAsUseOf
+      extend ActiveSupport::Concern
+
+      def acts_as_use_of(*model_symbols)
+        extend ClassMethods
+        include InstanceMethods
+
+        self.used_in = model_symbols
+
+        # Relationships
+        has_many :uses, as: :use_in, class_name: 'Cookbook::Use'
+        associate_used_in
+      end
+
+      # Extended by has_cookbook mixin
+      module ClassMethods
+        attr_accessor(:used_in)
+
+        def associate_used_in
+          used_in.each do |table_sym|
+            model = table_sym.to_s.classify.constantize
+            name = model.model_name.to_s
+            uses_symbol = "#{model.model_name.param_key}_uses".to_sym
+
+            has_many uses_symbol, lambda {
+              where(use_of_type: name)
+            }, as: :use_in, class_name: 'Cookbook::Use'
+            accepts_nested_attributes_for uses_symbol, reject_if: :all_blank, allow_destroy: true
+
+            has_many table_sym, through: :uses, source: :use_of, source_type: name
+          end
+        end
+      end
+
+      # Included by has_cookbook mixin
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/cookbook/mixins/acts_as_used_in.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Cookbook
+  module Mixins
+    # ActsAsUseIn Mixin, for things like Tools, Supplies, or Ingredients
+    module ActsAsUsedIn
+      extend ActiveSupport::Concern
+
+      def acts_as_used_in(*model_symbols)
+        extend ClassMethods
+        include InstanceMethods
+
+        self.uses_of = model_symbols
+        self.label_method = :name
+
+        # Relationships
+        has_many :uses, as: :use_of, class_name: 'Cookbook::Use'
+        associate_uses_of
+      end
+
+      # Extended by acts_as_used_in mixin
+      module ClassMethods
+        attr_accessor :uses_of, :label_method
+
+        def associate_uses_of
+          uses_of.each do |table_sym|
+            model = table_sym.to_s.classify.constantize
+            name = model.model_name.to_s
+
+            has_many "#{model.model_name.param_key}_uses".to_sym, lambda {
+              where(use_in_type: name)
+            }, as: :use_of, class_name: 'Cookbook::Use'
+            has_many table_sym, through: :uses, source: :use_in, source_type: name
+          end
+        end
+      end
+
+      # Included by has_cookbook mixin
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/cookbook/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Cookbook
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/cookbook/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Cookbook module
+module Cookbook
+  VERSION = File.read(File.expand_path('../../VERSION', __dir__))
+  def self.version_string
+    "Cookbook version #{Cookbook::VERSION}"
+  end
+end

data/lib/cookbook.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Cookbook Module
+module Cookbook
+  require 'active_record/railtie'
+  require 'action_controller/railtie'
+  require 'action_view/railtie'
+  require 'sprockets/railtie'
+
+  require 'cookbook/configuration'
+  require 'cookbook/engine'
+  require 'cookbook/railtie'
+  require 'cookbook/version'
+
+  require 'cookbook/mixins/acts_as_used_in'
+  require 'cookbook/mixins/acts_as_use_of'
+  require 'cookbook/extensions/float'
+
+  require 'haml-rails'
+  require 'sass-rails'
+  require 'simple_form'
+  require 'vanilla_nested'
+  require 'cancancan' if Cookbook.configuration.authorize_with == :cancancan
+end
+
+ActiveRecord::Base.extend Cookbook::Mixins::ActsAsUsedIn
+ActiveRecord::Base.extend Cookbook::Mixins::ActsAsUseOf

data/lib/tasks/cookbook_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :cookbook do
+#   # Task goes here
+# end

data/lib/templates/haml/scaffold/_form.html.haml

@@ -0,0 +1,12 @@
+-# frozen_string_literal: true
+= simple_form_for(@<%= singular_table_name %>) do |f|
+  = f.error_notification
+  = f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present?
+
+  .form-inputs
+  <%- attributes.each do |attribute| -%>
+    = f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %>
+  <%- end -%>
+
+  .form-actions
+    = f.button :submit

data/spec/cookbook_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe 'Cookbook' do
+  it 'should return correct version string' do
+    Cookbook.version_string.should == "Cookbook version #{Cookbook::VERSION}"
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# 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_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

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 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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/assets/stylesheets/scaffolds.scss

@@ -0,0 +1,65 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px; }
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px; }
+
+a {
+  color: #000; }
+
+a:visited {
+  color: #666; }
+
+a:hover {
+  color: #fff;
+  background-color: #000; }
+
+th {
+  padding-bottom: 5px; }
+
+td {
+  padding: 0 5px 7px; }
+
+div.field,
+div.actions {
+  margin-bottom: 10px; }
+
+#notice {
+  color: green; }
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table; }
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0; }
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff; }
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square; }
+
+label {
+  display: block; }

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Controller for HowTos, like "How to build a dog house"
+class HowTosController < ApplicationController
+  include Cookbook::Params
+  before_action :set_how_to, only: %i[show edit update destroy]
+
+  # GET /how_tos
+  def index
+    @how_tos = HowTo.all
+  end
+
+  # GET /how_tos/1
+  def show; end
+
+  # GET /how_tos/new
+  def new
+    @how_to = HowTo.new
+  end
+
+  # GET /how_tos/1/edit
+  def edit; end
+
+  # POST /how_tos
+  def create
+    @how_to = HowTo.new(how_to_params)
+
+    if @how_to.save
+      redirect_to @how_to, notice: 'How to was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT /how_tos/1
+  def update
+    if @how_to.update(how_to_params)
+      redirect_to @how_to, notice: 'How to was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  # DELETE /how_tos/1
+  def destroy
+    @how_to.destroy
+    redirect_to how_tos_url, notice: 'How to was successfully destroyed.'
+  end
+
+  private
+
+  # Use callbacks to share common setup or constraints between actions.
+  def set_how_to
+    @how_to = HowTo.find(params[:id])
+  end
+
+  # Only allow a list of trusted parameters through.
+  def how_to_params
+    params.require(:how_to).permit(:name, :description, :instructions, cookbook_params('HowTo'))
+  end
+end