strain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8bd2143f350cd14055cb960e4a5417ecb399aa1
+  data.tar.gz: 33c4f04e99b02f07346ade026a40922459b2ea55
+SHA512:
+  metadata.gz: af675aa2058612873c92964fc55fee788daff7785dab78cc7250c2ccf96bb6bb3b793034a3b7cd6f1ceeeaec74bc109c2c353cca65d1a21ad761fa260240247a
+  data.tar.gz: 93da7fab31a045e687a062b50a79a4a3ed172de27934a9b30498b6d54e17e5272a3acd5b1cc4ebff9ee4e31303258d640c1186437ad1f8280493352a246df38c

data/.gitignore

@@ -0,0 +1,14 @@
+Gemfile.lock
+*.gem
+
+.bundle/
+log/*.log
+pkg/
+
+spec/test_app/db/*.sqlite3
+spec/test_app/db/*.sqlite3-journal
+spec/test_app/log/*.log
+spec/test_app/tmp/
+spec/test_app/.sass-cache
+spec/reports/
+spec/examples.txt

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in strain.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+gem 'pry-rails', group: [:development, :test]
+# gem 'jsonapi-resources', path: '~/dev/opc/jr-new/jsonapi-resources'
+# gem 'jsonapi-resources', :git => 'git://github.com/ggordon/jsonapi-resources.git', :ref => '7a943c883c9cc4cec748de39593ce368c467c7ab'
+gem 'jsonapi-resources', :git => 'git://github.com/cerebris/jsonapi-resources.git', :ref => '730f751'

data/Guardfile

@@ -0,0 +1,72 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bin/rspec" do
+  clearing :on
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      # rspec.spec.("routing/#{m[1]}_routing"),
+      # rspec.spec.("controllers/#{m[1]}_controller"),
+      # rspec.spec.("acceptance/#{m[1]}"),
+      rspec.spec.("requests/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  # watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  # watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  # watch(%r{^spec/acceptance/(.+)\.feature$})
+  # watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+  #   Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  # end
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Adam Worrall
+
+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/README.md

@@ -0,0 +1,74 @@
+# Strain
+
+
+## Description
+
+### What does it do?
+
+
+Strain is an experimental Rails engine that exposes [JSON API][1] endpoints for quickly defining and editing structured content. By providing a [JSON Schema][2] you get user-editable content types with shared server-side and client-side validation and, through the upcoming `Strain-admin` editor, autogenerated rich admin interfaces built with React.
+
+Once your content models are stable, you can extend the underlying models with STI to add additional logic. In the future, Strain will be able to generate migrations to promote your content types to full-fledged ActiveRecord models.
+
+_Note: This gem is experimental, and will be changing rapidly._
+
+[1]: http://google.com/         "JSON API"
+[2]: http://json-schema.org/    "JSON Schema"
+
+### Why do this?
+
+http://alistapart.com/article/future-ready-content
+
+TODO
+
+## Requirements
+
+- Ruby 2.0.0
+- PostgreSQL 9.4 (for `jsonb` support)
+- Rails 4.2
+
+## Installation
+
+### Install Strain and its dependencies
+
+Add Strain to your Rails application's `Gemfile`. As of 0.0.1, Strain also depends on a prerelease version of `jsonapi-resources` that needs to be added to your `Gemfile`. This requirement will be eliminated as soon as possible.
+
+``` ruby
+gem 'strain'
+gem 'jsonapi-resources', :git => 'git://github.com/cerebris/jsonapi-resources.git', :ref => '730f751'
+```
+
+After adding the above lines to your `Gemfile`, run:
+
+```
+$ bundle
+```
+
+### Install migrations
+
+After installing the gem, install and run the migrations needed to set up the Strain database tables. This will also enable the Postgres UUID extension.
+
+```
+$ rake strain:install:migrations
+$ rake db:migrate
+```
+
+### Mount the engine
+
+In `routes.rb`, specify the route that you'd like the Strain controller to handle:
+
+```
+mount Strain::Engine => "/strain"
+```
+
+## Usage
+
+TODO
+
+## Feedback
+
+I'd love to discuss any ideas or suggestions you might have. Please file an issue or get in touch with @remedy on Twitter.
+
+## License
+
+Copyright 2015 Adam Worrall. MIT License (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,26 @@
+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    = 'Strain'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+# Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/strain/jsonapi/articles.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/strain/jsonapi/variants.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/strain/jsonapi/articles.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/strain/jsonapi/variants.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/strain/application_controller.rb

@@ -0,0 +1,5 @@
+module Strain
+  class ApplicationController < ActionController::Base
+
+  end
+end

data/app/controllers/strain/jsonapi/articles_controller.rb

@@ -0,0 +1,6 @@
+require_dependency "strain/application_controller"
+
+module Strain
+  class Jsonapi::ArticlesController < Strain::Jsonapi::JsonapiController
+  end
+end

data/app/controllers/strain/jsonapi/jsonapi_controller.rb

@@ -0,0 +1,10 @@
+# require_dependency "strain/application_controller"
+
+module Strain
+  class Jsonapi::JsonapiController < Strain::ApplicationController
+
+    include JSONAPI::ActsAsResourceController
+
+  end
+end
+

data/app/controllers/strain/jsonapi/variants_controller.rb

@@ -0,0 +1,7 @@
+# require_dependency "strain/application_controller"
+
+module Strain
+  class Jsonapi::VariantsController < Strain::Jsonapi::JsonapiController
+  end
+end
+

data/app/helpers/strain/jsonapi/articles_helper.rb

@@ -0,0 +1,4 @@
+module Strain
+  module Jsonapi::ArticlesHelper
+  end
+end

data/app/helpers/strain/jsonapi/variants_helper.rb

@@ -0,0 +1,4 @@
+module Strain
+  module Jsonapi::VariantsHelper
+  end
+end

data/app/models/strain/article.rb

@@ -0,0 +1,37 @@
+module Strain
+  class Article < ActiveRecord::Base
+    belongs_to :variant, inverse_of: :articles
+
+    self.inheritance_column = :strain_type
+
+    delegate :schema, to: :variant
+    delegate :name, to: :variant, prefix: true
+
+    before_validation :set_defaults_from_schema
+
+    validates_presence_of :slug, :variant, :body, :title
+    validates :slug, format: {
+      with: /\A[a-z0-9-]+\z/,
+      message: "must contain only letters, numbers, and hyphens."}
+    validates :slug, uniqueness: { case_sensitive: false }
+    validate :body_must_conform_to_variant_schema
+
+    private
+
+    def set_defaults_from_schema
+      return if variant.nil?
+      return if body.nil?
+      return if title.nil?
+      self.body = Strain::SchemaTools::Defaults.new(schema, body).data_with_defaults
+    end
+
+    def body_must_conform_to_variant_schema
+      return if variant.nil?
+      # JSON::Validator.fully_validate(schema, body.to_h, errors_as_objects: true)
+      unless JSON::Validator.validate(schema, body.to_h)
+        errors.add(:body, "does not conform to #{variant.name} schema.")
+      end
+    end
+
+  end
+end

data/app/models/strain/variant.rb

@@ -0,0 +1,32 @@
+module Strain
+  class Variant < ActiveRecord::Base
+
+    has_many :articles, inverse_of: :variant
+
+    validates_presence_of :name
+    validates_presence_of :schema
+    validate :schema_must_be_valid
+    validate :schema_root_must_be_object
+    validates :name, uniqueness: { case_sensitive: false }
+
+    private
+
+    def schema_must_be_valid
+      meta_schema = JSON.load(
+        File.read("#{::Strain::Engine.root}/lib/json_schema/draft_4_meta_schema.json")
+      )
+      unless JSON::Validator.validate(meta_schema, self.schema)
+        errors.add(:schema, "must be a valid Draft 4 JSON Variant.")
+      end
+    end
+
+    def schema_root_must_be_object
+      return if schema.blank?
+      #TODO: check for schema w/o 'type' key set at all
+      unless schema.fetch("type") == "object"
+        errors.add(:schema, "must have an object as root element.")
+      end
+    end
+
+  end
+end

data/app/resources/strain/jsonapi/article_resource.rb

@@ -0,0 +1,21 @@
+module Strain
+  class Jsonapi::ArticleResource < JSONAPI::Resource
+    model_name "::Strain::Article"
+
+    attribute :slug
+    attribute :title
+    attribute :variant_id
+    # attribute :variant
+    attribute :schema
+    attribute :variant_name
+    attribute :body
+
+    relationship :variant, to: :one
+
+    # https://github.com/cerebris/jsonapi-resources/issues/523
+    def self.resource_type_for(model)
+      'strain/jsonapi/article'
+    end
+
+  end
+end

data/app/resources/strain/jsonapi/variant_resource.rb

@@ -0,0 +1,16 @@
+module Strain
+  class Jsonapi::VariantResource < JSONAPI::Resource
+    model_name "::Strain::Variant"
+
+    attribute :name
+    attribute :schema
+
+    relationship :articles, to: :many
+
+    # https://github.com/cerebris/jsonapi-resources/issues/523
+    def self.resource_type_for(model)
+      'strain/jsonapi/variant'
+    end
+
+  end
+end

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', '_guard-core')

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/strain/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/config/initializers/jsonapi_resources.rb

@@ -0,0 +1,4 @@
+JSONAPI.configure do |config|
+  # Allowed values are :integer(default), :uuid, :string, or a proc
+  config.resource_key_type = :uuid
+end

data/config/routes.rb

@@ -0,0 +1,8 @@
+Strain::Engine.routes.draw do
+
+  namespace :jsonapi do
+    jsonapi_resources :variants
+    jsonapi_resources :articles
+  end
+
+end

data/db/migrate/20151103060035_enable_uuid.rb

@@ -0,0 +1,5 @@
+class EnableUuid < ActiveRecord::Migration
+  def change
+    enable_extension 'uuid-ossp'
+  end
+end

data/db/migrate/20151103060224_create_strain_variants.rb

@@ -0,0 +1,11 @@
+class CreateStrainVariants < ActiveRecord::Migration
+  def change
+    create_table :strain_variants, id: :uuid do |t|
+      t.string :name, null: false
+      t.jsonb :schema, null: false
+
+      t.timestamps null: false
+    end
+    add_index :strain_variants, :name, :unique => true
+  end
+end

data/db/migrate/20151104200908_create_strain_articles.rb

@@ -0,0 +1,14 @@
+class CreateStrainArticles < ActiveRecord::Migration
+  def change
+    create_table :strain_articles, id: :uuid do |t|
+      t.uuid :variant_id, index: true, foreign_key: true
+      t.string :strain_type, null: false, default: 'Strain::Article'
+      t.string :title, null: false
+      t.jsonb :body, null: false
+      t.string :slug, null: false
+
+      t.timestamps null: false
+    end
+    add_index :strain_articles, :slug, :unique => true
+  end
+end