gatherable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09b8a7e4dbf788cde1816d9c319af7817648d106
+  data.tar.gz: c52691404ee19dd12f5eb7be2752495e2f27a210
+SHA512:
+  metadata.gz: 1e9b02a9b1aa75cb979d40efb00ede2c2e59e3067d8fc8859f7c5f04950409016cdee746abeb9e65e6d405876f2e8b4574d97f22153859b6ae1505f07664598f
+  data.tar.gz: 0e3f799004046b602253c04377ab576a40532bd4e5d84dd57a9962c3265a5d27fbd7e45de5aaf15d36d163f22777c199b0c0abd6c8ac16d0e8a40a02643b6304

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Daniel Schepers
+
+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,6 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+Dir.glob('lib/tasks/*.rake').each { |r| load r}

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

@@ -0,0 +1,43 @@
+module Gatherable
+  class ApplicationController < ::ActionController::Base
+    def show
+      render :json => model_class.find(params[model_id]), :status => :found
+    rescue ActiveRecord::RecordNotFound => e
+      render :json => { :errors => e.message}, :status => :not_found
+    end
+
+    def create
+      render :json => model_class.create(model_params), :status => :created
+    rescue ActionController::ParameterMissing => e
+      render :json => { :errors => e.message}, :status => :unprocessable_entity
+    end
+
+    private
+
+    def model_class
+      Object.const_get(model_name)
+    end
+
+    def model_name
+      self.class.to_s.chomp('Controller').singularize
+    end
+
+    def model_id
+      "#{unmodularized_model_name}_id"
+    end
+
+    def unmodularized_model_name
+      model_name.split('::').last.downcase
+    end
+
+    def model_params
+      params.require(unmodularized_model_name).permit(
+        *model_class.column_names
+      ).merge(global_identifier => params[global_identifier])
+    end
+
+    def global_identifier
+      Gatherable.config.global_identifier
+    end
+  end
+end

data/app/models/data_point.rb

@@ -0,0 +1,28 @@
+class DataPoint
+  attr_reader :name, :data_type
+  def initialize(name, data_type)
+    @name = name
+    @data_type = data_type
+  end
+
+  def class_name
+    name.to_s.classify
+  end
+
+  def controller_name
+    "#{class_name.pluralize}Controller"
+  end
+
+  def classify
+    return Gatherable.const_get(class_name) if Gatherable.const_defined?(class_name)
+    klass = Gatherable.const_set(class_name, Class.new(ActiveRecord::Base))
+    klass.table_name = name.to_s.pluralize
+    klass.table_name_prefix = Gatherable.config.schema_name + '.'
+    klass
+  end
+
+  def controllerify
+    return Gatherable.const_get(controller_name) if Gatherable.const_defined?(controller_name)
+    Gatherable.const_set(controller_name, Class.new(Gatherable::ApplicationController))
+  end
+end

data/app/writers/controller_writer.rb

@@ -0,0 +1,34 @@
+class ControllerWriter
+  attr_reader :data_point
+  def initialize(data_point)
+    @data_point = data_point
+  end
+
+  def write
+    if File.exists?(filename)
+      puts "Controller already defined for #{data_point.name}. Skipping"
+      return
+    end
+    FileUtils.mkdir_p('app/controllers/gatherable')
+    File.open(filename, 'w') do |f|
+      f.puts controller_contents
+    end
+    puts "created #{filename}" if File.exists?(filename)
+  end
+
+  private
+
+  def filename
+    controller_file = "#{data_point.name.to_s.pluralize}_controller.rb"
+    File.join(Rails.root, 'app', 'controllers', 'gatherable', controller_file)
+  end
+
+  def controller_contents
+    <<-controller
+module Gatherable
+  class #{data_point.controller_name} < Gatherable::ApplicationController
+  end
+end
+    controller
+  end
+end

data/app/writers/migration_writer.rb

@@ -0,0 +1,90 @@
+class MigrationWriter
+  attr_reader :data_point
+
+  def initialize(data_point)
+    @data_point = data_point
+  end
+
+  def self.write_schema_migration
+    FileUtils.mkdir_p('db/migrate')
+    return if schema_migration_created?
+    File.open(schema_migration, 'w') do |f|
+      f.puts <<-schema_migration
+class CreateGatherableSchema < ActiveRecord::Migration
+  def up
+    create_schema '#{Gatherable.config.schema_name}'
+  end
+
+  def down
+    drop_schema '#{Gatherable.config.schema_name}'
+  end
+end
+      schema_migration
+    end
+    puts "created #{schema_migration}" if File.exists?(schema_migration)
+  end
+
+  def write
+    if matching_migrations.present?
+      puts already_found_message
+      return
+    end
+    FileUtils.mkdir_p('db/migrate')
+    filename = "db/migrate/#{self.class.unique_timestamp}_#{file_suffix}"
+    File.open(filename, 'w') do |f|
+      f.puts file_template
+    end
+    puts "created #{filename}" if File.exists?(filename)
+  end
+
+  private
+
+  def self.unique_timestamp
+    t = Time.now
+    t += 1 while Dir[File.join('db', 'migrate', "#{t.strftime("%Y%m%d%H%M%S")}*.rb")].present?
+    t.strftime("%Y%m%d%H%M%S")
+  end
+
+  def self.schema_migration_created?
+    Dir[File.join('db', 'migrate', "*create_gatherable_schema.rb")].present?
+  end
+
+  def self.schema_migration
+    "db/migrate/#{unique_timestamp}_create_gatherable_schema.rb"
+  end
+
+  def table_name
+    @table_name ||= data_point.classify.table_name
+  end
+
+  def file_template
+    data_type = data_point.data_type.to_s
+    <<-template
+class CreateGatherable#{table_name.classify} < ActiveRecord::Migration
+  def up
+    create_table '#{Gatherable.config.schema_name}.#{table_name}', :primary_key => '#{data_point.name}_id' do |t|
+      t.#{data_type} :#{data_point.name}, :null => false
+      t.string :#{Gatherable.config.global_identifier}, :index => true
+      t.timestamps :null => false
+    end
+  end
+
+  def down
+    drop_table '#{Gatherable.config.schema_name}.#{table_name}'
+  end
+end
+    template
+  end
+
+  def file_suffix
+    @file_suffix ||= "create_gatherable_#{table_name.singularize}.rb"
+  end
+
+  def already_found_message
+    "migrations #{matching_migrations} already exist. Skipping migration for #{data_point.name}"
+  end
+
+  def matching_migrations
+    @matches ||= Dir[File.join('db', 'migrate', "*#{file_suffix}")]
+  end
+end

data/app/writers/model_writer.rb

@@ -0,0 +1,36 @@
+class ModelWriter
+  attr_reader :data_point
+  def initialize(data_point)
+    @data_point = data_point
+  end
+
+  def write
+    if File.exists?(filename)
+      puts "model already defined for #{data_point.name}. Skipping"
+      return
+    end
+    FileUtils.mkdir_p('app/models/gatherable')
+    File.open(filename, 'w') do |f|
+      f.puts model_contents
+    end
+    puts "created #{filename}" if File.exists?(filename)
+  end
+
+  private
+
+  def filename
+    model_file = "#{data_point.name}.rb"
+    File.join(Rails.root, 'app', 'models', 'gatherable', model_file)
+  end
+
+  def model_contents
+    <<-model
+module Gatherable
+  class #{data_point.class_name} < ActiveRecord::Base
+    self.table_name = '#{data_point.name.to_s.pluralize}'
+    self.table_name_prefix = 'gatherable.'
+  end
+end
+    model
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+#Gatherable::Engine.routes.draw do
+#end

data/lib/gatherable.rb

@@ -0,0 +1,41 @@
+require "gatherable/engine"
+require "gatherable/configuration"
+require 'pry'
+
+module Gatherable
+  class << self
+    def configure
+      return unless configuration.empty?
+      yield configuration
+      create_models
+      create_controllers
+      create_routes
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    alias :config :configuration
+
+    private
+
+    def create_models
+      config.data_points.map(&:classify)
+    end
+
+    def create_controllers
+      config.data_points.map(&:controllerify)
+    end
+
+    def create_routes
+      global_identifier = config.global_identifier
+      Gatherable::Engine.routes.draw do #would this wipe away whatever's in config/routes.rb?
+        Gatherable.config.data_points.map{ |dp| dp.name.to_s.pluralize }.each do |data_point|
+          scope :path => "/:#{global_identifier}" do
+            resources data_point.to_sym, :only => [:show, :create], :param => "#{data_point.singularize}_id"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gatherable/configuration.rb

@@ -0,0 +1,19 @@
+module Gatherable
+  class Configuration
+    delegate :empty?, :to => :data_points
+    attr_accessor :global_identifier
+    attr_writer :schema_name
+
+    def data_point(name, data_type)
+      data_points << DataPoint.new(name, data_type)
+    end
+
+    def data_points
+      @data_points ||= []
+    end
+
+    def schema_name
+      @schema_name || 'gatherable'
+    end
+  end
+end

data/lib/gatherable/engine.rb

@@ -0,0 +1,5 @@
+module Gatherable
+  class Engine < ::Rails::Engine
+    isolate_namespace Gatherable
+  end
+end

data/lib/gatherable/version.rb

@@ -0,0 +1,3 @@
+module Gatherable
+  VERSION = "0.0.1"
+end

data/lib/generators/gatherable/USAGE

@@ -0,0 +1,32 @@
+Uses:
+   --------------------------------------
+
+    rails generate gatherable initializer
+
+    This will create:
+        config/initializers/gatherable.rb
+
+   --------------------------------------
+
+    rails generate gatherable migrations
+
+    This will create migrations for each data_point in
+    config/initializers/gatherable.rb
+
+   --------------------------------------
+
+    rails generate gatherable models
+
+    This will create models for each data_point in
+    config/initializers/gatherable.rb. The new models
+    will be stored in app/models/gatherable/
+
+   --------------------------------------
+
+    rails generate gatherable controllers
+
+    This will create models for each data_point in
+    config/initializers/gatherable.rb. The new models
+    will be stored in app/controllers/gatherable/
+
+   --------------------------------------

data/lib/generators/gatherable/gatherable_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+class GatherableGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  def generate
+    send "generate_#{file_name}"
+  end
+
+  private
+
+  def generate_initializer
+    copy_file "gatherable.rb", "config/initializers/gatherable.rb"
+  end
+
+  def generate_migrations
+    MigrationWriter.write_schema_migration
+    Gatherable.config.data_points.each do |data_point|
+      MigrationWriter.new(data_point).write
+    end
+  end
+
+  def generate_models
+    Gatherable.config.data_points.each do |data_point|
+      ModelWriter.new(data_point).write
+    end
+  end
+
+  def generate_controllers
+    copy_file 'application_controller.rb', 'app/controllers/gatherable/application_controller.rb'
+    Gatherable.config.data_points.each do |data_point|
+      ControllerWriter.new(data_point).write
+    end
+  end
+end

data/lib/generators/gatherable/templates/application_controller.rb

@@ -0,0 +1,43 @@
+module Gatherable
+  class ApplicationController < ::ActionController::Base
+    def show
+      render :json => model_class.find(params[model_id]), :status => :found
+    rescue ActiveRecord::RecordNotFound => e
+      render :json => { :errors => e.message}, :status => :not_found
+    end
+
+    def create
+      render :json => model_class.create(model_params), :status => :created
+    rescue ActionController::ParameterMissing => e
+      render :json => { :errors => e.message}, :status => :unprocessable_entity
+    end
+
+    private
+
+    def model_class
+      Object.const_get(model_name)
+    end
+
+    def model_name
+      self.class.to_s.chomp('Controller').singularize
+    end
+
+    def model_id
+      "#{unmodularized_model_name}_id"
+    end
+
+    def unmodularized_model_name
+      model_name.split('::').last.downcase
+    end
+
+    def model_params
+      params.require(unmodularized_model_name).permit(
+        *model_class.column_names
+      ).merge(global_identifier => params[global_identifier])
+    end
+
+    def global_identifier
+      Gatherable.config.global_identifier
+    end
+  end
+end