cookbook 0.1.0

data/README.md

@@ -0,0 +1,105 @@
+# Works Cited
+Works Cited allows you to add a list of the works cited in ActiveRecord objects, to be formatted by a helper that can be added to relevant pages to format the citations like a bibliography.
+
+Works Cited uses CanCanCan to authorize the editing of citations. This makes it easy for you to control access.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'works_cited'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Then generate the migrations
+```bash
+$ rake cookbook:install:migrations
+$ rake db:migrate
+```
+
+## Configuration
+
+You will need to add access for the people who should be authorized. Cookbook uses CanCanCan for authorization. Simply add the appropriate permissions to your ability.rb file:
+
+```ruby
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    user ||= User.new
+
+    can :read, Cookbook::Use
+    can :read, Recipe
+    can :read, Ingredient
+
+    return if user.new_record? # Anonymous Users leave
+
+    # # We could have other rules in here, like:
+    # can :manage, Cookbook::Use, use_of: { user_id: user.id }, use_in: { user_id: user.id }
+
+    return unless user.admin? # Non Admin Users leave
+
+    can :manage, Cookbook::Use
+    can :manage, Recipe
+    can :manage, Ingredient
+  end
+end
+```
+
+## Usage
+Make a model ready to accept uses, such as Recipe or Instructions
+
+```ruby
+acts_as_use_of
+```
+
+Make a model a thing that gets used, such as Ingredient or Tool
+
+```ruby
+acts_as_used_in
+```
+
+Add the helpers to the relevant views
+
+```haml
+= cookbook_uses_of @ingredient
+-# OR
+= cookbook_used_in @recipe
+```
+
+Add the fields to your instructional forms (e.g. Recipes)
+
+```haml
+= form_for(@recipe) do |f|
+  = cookbook_fields f
+```
+
+Don't forget to add the controller concern to enable nested attributes with strong parameters
+
+```ruby
+class RecipesController < ApplicationController
+  include Cookbook::Params
+
+  #...
+    
+  def recipe_params
+    params.require(:recipe).permit(:name, :description, :serves, :meal, :instructions, cookbook_params('Recipe'))
+  end
+end
+```
+
+## Contributing
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## License
+Copyright (c) 2021 Loren Lundgren. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'cookbook'
+  gem.homepage = 'https://gemvein.com/museum/cases/cookbook'
+  gem.metadata = { source_code_uri: 'http://github.com/gemvein/cookbook' }
+  gem.license = 'MIT'
+  gem.summary = %(Mountable Engine to show instructions with components, like a cookbook or instruction manual)
+  gem.description = 'Cookbook allows you to associate instructions with components in a cross referenced way. '\
+                    'Good for cooking recipes or an instruction manual for DIY projects.'
+  gem.email = 'loren.lundgren@gmail.com'
+  gem.authors = ['Loren Lundgren']
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['test'].execute
+end
+
+task default: :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cookbook #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/assets/stylesheets/cookbook/application.scss

@@ -0,0 +1,180 @@
+$danger-color: darkred;
+
+$button-color: darkgray;
+$button-text-color: white;
+$button-link-color: darkslateblue;
+$button-link-text-color: white;
+$button-action-color: darkolivegreen;
+$button-action-text-color: white;
+$button-danger-color: darkred;
+$button-danger-text-color: white;
+
+$table-border-color: darkgray;
+$fieldset-border-color: darkgray;
+$hr-border-color: darkgray;
+
+$shadow-color: rgba(darkgray, 0.5);
+
+.button, button, input[type=button], input[type=submit], .item-actions li a {
+  background: $button-color;
+  color: $button-text-color;
+  padding: 0.5rem 1.25rem;
+  border-radius: 0.33rem;
+  border: 1px lighten($button-color, 20%) outset;
+  box-shadow: 2px 2px 2px $shadow-color;
+  display: inline-block;
+
+  &:active {
+    border-style: inset;
+    box-shadow: 1px 1px 2px rgba($shadow-color, 0.5);
+  }
+
+  &.button-link {
+    background-color: $button-link-color;
+    border-color: lighten($button-link-color, 20%);
+    color: $button-link-text-color;
+
+    &:active {
+      background: darken($button-link-color, 20%);
+    }
+  }
+
+  &.button-action {
+    background-color: $button-action-color;
+    border-color: lighten($button-action-color, 20%);
+    color: $button-action-text-color;
+
+    &:active {
+      background: darken($button-action-color, 20%);
+    }
+  }
+
+  &.button-danger {
+    background-color: $button-danger-color;
+    border-color: lighten($button-danger-color, 10%);
+    color: $button-danger-text-color;
+
+    &:active {
+      background: darken($button-danger-color, 20%);
+    }
+  }
+
+  &.button-large {
+    font-size: 1.5rem;
+  }
+
+  &:active,
+  &:visited,
+  &:link,
+  &:hover {
+    text-decoration: none;
+  }
+
+  &.button-block {
+    display: block;
+    text-align: center;
+  }
+}
+
+table.table-data {
+  border-collapse: collapse;
+  border: solid 1px $table-border-color;
+
+  td, th {
+    border: solid 1px $table-border-color;
+    padding: 0.5rem;
+  }
+}
+
+.error {
+  font-weight: bold;
+  color: $danger-color;
+}
+
+.field_with_errors input, .field_with_errors select, .field_with_errors textarea {
+  border: 1px solid $danger-color;
+  box-shadow: 1px 1px 4px $danger-color;
+}
+
+.required abbr[title=required] {
+  font-weight: bold;
+  color: $danger-color;
+}
+
+.input, .actions {
+  display: grid;
+  grid-template-columns: 15rem 2fr 1fr;
+  grid-gap: 0.5rem;
+  margin-bottom: 0.5rem;
+
+  @media (max-width: 60rem) {
+    grid-template-columns: 10rem 1fr;
+  }
+
+  &.input-sort input {
+    width: 3rem;
+  }
+
+  label {
+    text-align: right;
+  }
+
+  input[type=text],
+  input[type=number],
+  input[type=password],
+  input[type=url],
+  input[type=email],
+  select,
+  textarea {
+    padding: 0.5rem;
+    font-size: 1.25rem;
+  }
+
+  input[type=text],
+  input[type=number],
+  input[type=password],
+  input[type=url],
+  input[type=email] {
+    height: 1.5rem;
+  }
+}
+
+label.checkbox {
+  display: flex;
+  justify-content: flex-start;
+  grid-column-start: 2;
+}
+
+.button-wrapper {
+  display: flex;
+  justify-content: flex-end;
+  grid-column-start: 2;
+}
+
+.radio-wrapper, .checkbox-wrapper {
+  display: grid;
+  grid-template-columns: 1rem 1fr;
+  grid-column-gap: 0.5rem;
+
+  label {
+    text-align: left;
+  }
+}
+
+textarea {
+  padding: 0.5rem;
+}
+
+fieldset {
+  border: solid 1px $fieldset-border-color;
+  margin: 1rem 10rem;
+
+  fieldset {
+    margin: 0 5rem;
+  }
+}
+
+.preview-html {
+  font-size: 1.2rem;
+  line-height: 1.5rem;
+}

data/app/controllers/concerns/cookbook/params.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Cookbook
+  # Concern to allow strong parameters when using accepts_nested_attributes_for to edit Cookbook Uses
+  module Params
+    extend ActiveSupport::Concern
+
+    included do
+      # rescue_from Pundit::NotAuthorizedError, with: :authorization_error
+      # include Pundit
+    end
+
+    def cookbook_params(model_name)
+      model = model_name.constantize
+
+      attributes = {}
+      model.used_in.each do |table_sym|
+        singular = table_sym.to_s.singularize
+        attribute_sym = "#{singular}_uses_attributes".to_sym
+        attributes[attribute_sym] = %i[
+          id _destroy use_of_type use_of_id quantity_minimum quantity_maximum unit preparation note sort
+        ]
+      end
+      attributes
+    end
+  end
+end

data/app/helpers/cookbook/application_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Cookbook
+  # Application Helper
+  module ApplicationHelper
+    def cookbook_uses_of(usable)
+      render 'cookbook/uses_of', uses: usable.uses
+    end
+
+    def cookbook_used_in(using)
+      render 'cookbook/used_in', usables: build_usables(using)
+    end
+
+    def cookbook_fields(form)
+      render 'cookbook/fields', form: form, usables: build_usables(form.object)
+    end
+
+    private
+
+    def build_usables(object)
+      object.class.used_in.map do |usable_table_sym|
+        build_usable(object, usable_table_sym)
+      end
+    end
+
+    def build_usable(object, usable_table_sym)
+      plural = usable_table_sym.to_s
+      singular = plural.singularize
+      uses_sym = "#{singular}_uses".to_sym
+      usable_model = plural.classify.constantize
+      singular_title = usable_model.model_name.human
+      OpenStruct.new(
+        title: singular_title.pluralize, singular_title: singular_title, uses: object.send(uses_sym),
+        uses_sym: uses_sym, plural_class: plural, singular_class: singular, table_sym: usable_table_sym
+      )
+    end
+  end
+end

data/app/models/cookbook/use.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cookbook
+  # Cookbook::Use is basically a linking table with extra information.
+  class Use < ApplicationRecord
+    # Relationships
+    belongs_to :use_in, polymorphic: true
+    belongs_to :use_of, polymorphic: true
+
+    # Scopes
+    scope :recipe_uses, -> { where use_in_type: 'Recipe' }
+    scope :ingredient_uses, -> { where use_of_type: 'Ingredient' }
+
+    # Methods
+    def quantity_with_unit
+      [quantity, unit].compact.join(' ')
+    end
+
+    def quantity
+      min = quantity_minimum&.format_quantity
+      max = quantity_maximum&.format_quantity
+
+      [min, max].compact.join('–') # ndash, not hyphen
+    end
+  end
+end

data/app/views/cookbook/_fields.html.haml

@@ -0,0 +1,11 @@
+= javascript_include_tag 'vanilla_nested'
+- if Cookbook.configuration.include_cookbook_css == true
+  = stylesheet_link_tag 'cookbook/application'
+- usables.each do |usable|
+  %fieldset.used_in{class: usable.plural_class}
+    %legend
+      %h3= usable.title
+    = link_to_add_nested form, usable.uses_sym, "##{usable.plural_class}", partial: 'cookbook/uses/fields', link_text: "Add #{usable.singular_title}", link_classes: 'button button-action'
+    %div{id: usable.plural_class}
+      = form.fields_for usable.uses_sym do |g|
+        = render 'cookbook/uses/fields', form: g, usable: usable