eots 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 382988daf11034b395b9733a59aa22560517bbdb
+  data.tar.gz: c57aef8c58c5883618e327386d60995e640053a3
+SHA512:
+  metadata.gz: ef40145fe2ae2597acc421d7b07949423aa2a6f8fd3478d238848a07637a1a5eaa6e75e58c7ad6abdb32ed03a207a6ebbd1a29817c5de36ea5156caf0260ebd1
+  data.tar.gz: 706caef30f3a11d3f81cb33ec2b83e20a8ec3735517941fef8a44489557ea0f377e1d8bb976c62c30a7b274f13d251ac25f21510225ecf9f2a288f4bb7c0afa6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Dave Aronson
+
+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/Rakefile

@@ -0,0 +1,33 @@
+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    = 'EOTS'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+task :default => :spec

data/app/assets/javascripts/eots/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 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_tree .

data/app/assets/stylesheets/eots/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 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/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+require "action_controller"
+
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/app/controllers/eots/eots_controller.rb

@@ -0,0 +1,33 @@
+module EOTS
+
+  class EOTSController < ApplicationController
+
+    include Rails.application.routes.url_helpers
+
+    before_action :get_view_context
+
+    def show
+      # TODO: make this just get the KIND
+      @kind = EOTS::find_kind(params[:kind])
+      render :show
+    end
+
+    def send_email
+      @email, errs = EOTS::Email.create_from_params(params)
+      if errs && errs.any?
+        flash.now[:alert] = errs.join("\n")
+        redirect_to request.url, request.params
+      end
+      EOTS::Mailer.email(@email).deliver_now
+      redirect_to root_path, notice: 'Your email has been sent'
+    end
+
+    private
+
+    def get_view_context
+      @view_context = view_context
+    end
+
+  end
+
+end

data/app/helpers/eots/application_helper.rb

@@ -0,0 +1,4 @@
+module EOTS
+  module ApplicationHelper
+  end
+end

data/app/mailers/eots/mailer.rb

@@ -0,0 +1,11 @@
+class EOTS::Mailer < ActionMailer::Base
+  def email(msg)
+    mail(from: msg.from,
+         to: msg.to,
+         cc: msg.cc,
+         bcc: msg.bcc,
+         reply_to: msg.reply_to,
+         subject: msg.values[:subject],
+         body: msg.body)
+  end
+end

data/app/models/eots/email.rb

@@ -0,0 +1,54 @@
+class EOTS::Email  # an instance, as opposed to the whole kind
+
+  attr_reader :kind, :values
+
+  EOTS::STANDARD_FIELDS.each do |field|
+    define_method(field) { kind.send field || values[:name] }
+  end
+
+  def initialize(kind, values={})
+    @kind = kind
+    @values = values.dup
+  end
+
+  def self.create_from_params(params)
+    kind_name = params[:kind]
+    kind = EOTS::find_kind(kind_name)
+    unless kind
+      raise(EOTS::EmailKind::NotFoundError,
+            "Unknown email kind '#{kind_name}': #{list}")
+    end
+    # TEMPORARY KLUGE, UNTIL I MAKE THE VALUES A SUB-HASH:
+    values = params.dup
+    %w(action controller authenticity_token commit kind utf8).each { |k| values.delete k }
+    check_value_names(values, kind) if values
+    self.new(kind, values)
+  end
+
+  def body
+    parts = [kind.name.titleize]
+    kind.form_fields.values.flatten.each do |field|
+      parts << "> #{"* " if field.html_options[:required]}#{field.label}"
+      reply = values[field.name]
+      parts << (reply.present? ? reply : "(not answered)")
+    end
+    parts.join("\n\n")
+  end
+
+  def from
+    kind.from || "\"#{values[:name]}\" <#{values[:email]}>"
+  end
+
+  private
+
+  def self.check_value_names(values, kind)
+    field_names = kind.form_fields.values.flatten.map &:name
+    errs = values.keys.reject { |key| field_names.include? key }
+    if errs.any?
+      list = errs.map { |e| "'#{e}'" }.join(", ")
+      raise(EOTS::EmailKind::FieldNotFoundError,
+            "Field(s) not found on email kind '#{kind.name}': #{list}")
+    end
+  end
+
+end

data/app/models/eots/email_kind.rb

@@ -0,0 +1,89 @@
+class EOTS::EmailKind
+
+  AlreadyDefinedError = Class.new(RuntimeError)
+  FieldNotFoundError = Class.new(RuntimeError)
+  NotFoundError = Class.new(RuntimeError)
+
+  attr_accessor :fields, :name, :parent, :options
+
+  EOTS::STANDARD_FIELDS.each do |field|
+    attr_writer field
+    define_method field do
+      instance_variable_get("@#{field}".to_sym) || parent.try(field)
+    end
+  end
+
+  EOTS::NON_FIELD_ITEMS.each { |field| attr_accessor field }
+
+  def initialize(name, parent, options={})
+    @name = name.to_s
+    opts = options.dup
+    @fields = {}
+    (EOTS::STANDARD_FIELDS + EOTS::NON_FIELD_ITEMS).each do |field|
+      instance_variable_set("@#{field}".to_sym, opts.delete(field))
+    end
+    @options = opts  # what's left
+    @parent = parent
+  end
+
+  def add_field(field_name, label, field_options)
+    field_name = field_name.to_s
+    if @fields[field_name]
+      raise(EOTS::Field::AlreadyDefinedError,
+            "Field #{field_name} is already defined on email kind #{self.name}")
+    end
+    @form_fields = nil # invalidate it... can't reach down to children tho :-(
+    # also return the new field, in case caller wants to do something with it
+    @fields[field_name] = EOTS::Field.new(field_name, label, field_options)
+  end
+
+  def body_fields
+    form_fields[:body]
+  end
+
+  def footer_fields
+    form_fields[:footer]
+  end
+
+  def footers
+    below = @parent ? @parent.footers : []
+    ([footer] + below).compact
+  end
+
+  def form_fields
+    unless @form_fields
+      @form_fields = @parent ? @parent.form_fields : { header: [], body: [], footer: [] }
+      mine = fields.values.group_by &:section
+      @form_fields[:header] += mine[:header] if mine[:header]
+      @form_fields[:body]   += mine[:body]   if mine[:body]
+      @form_fields[:footer]  = mine[:footer] + @form_fields[:footer] if mine[:footer]
+    end
+    @form_fields.dup  # dup so children don't add stuff
+  end
+
+  def header_fields
+    form_fields[:header]
+  end
+
+  def headers
+    above = @parent ? @parent.headers : []
+    (above << header).compact
+  end
+
+  def html_footers
+    wrap_in_html_paragraphs(footers)
+  end
+
+  def html_headers
+    wrap_in_html_paragraphs(headers)
+  end
+
+  private
+
+  def wrap_in_html_paragraphs(stuff)
+    if stuff.any?
+      "#{stuff.map { |thing| "<p>#{thing}</p>" }.join("\n")}<br/>".html_safe
+    end
+  end
+
+end

data/app/models/eots/field.rb

@@ -0,0 +1,71 @@
+class EOTS::Field
+
+  AlreadyDefinedError = Class.new(RuntimeError)
+  InvalidSectionError = Class.new(RuntimeError)
+
+  attr_reader :name, :label, :caption, :section, :html_options
+
+  def initialize(name, label, options={})
+    @name = name.to_s
+    @label = label
+    opts = options.dup
+    @caption = opts.delete(:caption)
+    @section = opts.delete(:section) || :body
+    unless [:header, :body, :footer].include? @section
+      raise(InvalidSectionError,
+            "Invalid section '#{@section}' -- must be :header, :body, or :footer")
+    end
+    apply_defaults(opts)
+    @html_options = opts
+  end
+
+  def html(form)
+    result = form.label_tag(name, "#{"* " if html_options[:required]}#{label}")
+    type = html_options[:type]
+    if type.to_sym == :checkbox  # to_sym 'cuz it could be string or symbol
+      result << form.content_tag(:span, " ")  # just to provide a spacer
+      opts = html_options.dup
+      checked = opts.delete :checked
+      result << form.check_box_tag(name, name, checked, opts)
+    else
+      result << form.tag(:br)
+      tag = "#{type}_field_tag".gsub("textarea_field", "text_area").to_sym
+      result << form.send(tag, name, nil, html_options)
+    end
+    if caption
+      result << form.tag(:br) 
+      result << form.content_tag(:small, caption)
+    end
+    result
+  end
+
+  private
+
+  def apply_defaults(opts)
+    opts[:type] ||= :text
+    case opts[:type].to_sym
+    when :checkbox
+      apply_check_box_defaults(opts)
+    when :text, :email
+      apply_text_defaults(opts)
+    when :text_area
+      apply_text_area_defaults(opts)
+    end
+  end
+
+  def apply_check_box_defaults(opts)
+    opts[:checked] = false unless opts.has_key?(:checked)
+  end
+
+  def apply_text_area_defaults(opts)
+    cols = (opts[:cols] ||= 60)
+    rows = (opts[:rows] ||= 5)
+    opts[:maxlength] ||= cols * rows
+  end
+
+  def apply_text_defaults(opts)
+    size = (opts[:size] ||= 60)
+    opts[:maxlength] ||= size
+  end
+
+end

data/app/views/eots/eots/_field.html.erb

@@ -0,0 +1,3 @@
+<%= field.html(@view_context) %>
+<br/>
+<br/>

data/app/views/eots/eots/show.html.erb

@@ -0,0 +1,17 @@
+<br/>
+
+<%= @kind.html_headers %>
+
+<%= form_tag(request.url) do %>
+
+  <%= render :partial => "field", :collection => @kind.header_fields %>
+  <%= render :partial => "field", :collection => @kind.body_fields %>
+  <%= render :partial => "field", :collection => @kind.footer_fields %>
+
+  <%= submit_tag "Send" %>
+
+<% end %>
+
+<br/>
+
+<%= @kind.html_footers %>

data/app/views/layouts/eots/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>EOTS</title>
+  <%= stylesheet_link_tag    "eots/application", media: "all" %>
+  <%= javascript_include_tag "eots/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+EOTS::Engine.routes.draw do
+  get "/:kind", :to => "eots#show"
+  post "/:kind", :to => "eots#send_email"
+end

data/lib/eots.rb

@@ -0,0 +1,57 @@
+require "eots/engine"
+
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym "EOTS"
+end
+
+module EOTS
+
+  # standard fields you'd see in any email
+  STANDARD_FIELDS = %i(from to reply_to cc bcc subject)
+
+  # need a better short name for this... stuff we want to let the dev pass in
+  # the email_kind declaration, either as an option or in the block, other than
+  # fields....
+  NON_FIELD_ITEMS = %i(header footer)
+
+  def self.email_kind(name, options={}, &block)
+    kind = create_email_kind(name, options)
+    @@kind_stack.push kind
+    yield if block_given?
+    @@kind_stack.pop
+  end
+
+  def self.field(name, label, options={})
+    @@kind_stack.last.add_field(name, label, options)
+  end
+
+  def self.find_kind(kind_name)
+    kind = @@kind_hash[kind_name]
+    unless kind
+      raise(EOTS::EmailKind:: NotFoundError,
+            "Unknown email kind '#{kind_name}'")
+    end
+    kind
+  end
+
+  (STANDARD_FIELDS + NON_FIELD_ITEMS).each do |field|
+    define_singleton_method field do |value|
+      @@kind_stack.last.send "#{field}=".to_sym, value
+    end
+  end
+
+  private
+
+  # declare/init innards this way so we can reset them in tests
+  def self.reset
+    @@kind_stack = []
+    @@kind_hash = {}
+  end
+  self.reset
+
+  def self.create_email_kind(name, options)
+    raise(EmailKind::AlreadyDefinedError, "Email kind #{name} is already defined") if @@kind_hash[name]
+    @@kind_hash[name] = EOTS::EmailKind.new(name, @@kind_stack.last, options)
+  end
+
+end