model_base_generators 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9828c5069fa9a791bcadc2a8997f1314fdb5583
+  data.tar.gz: 9d7a3b8935357a7fddfe116443af571f0d2f0bf3
+SHA512:
+  metadata.gz: 26f67945497b8986c14b2785281fafea3bec90c855d324946aba03653bd6a86cb6e2ebed34376f71da44a4fbf3241ef9e241738e25c177fe6d7100681af2e6a2
+  data.tar.gz: 004427808a77a01c6f0f207bf16940973dbb2cc8cac3aa64069b3e381d22584f70aa1e1679882b7f14e52d6616e14121f4fda7c06ac24841bb41e9690421a9db

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at akm2000@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in model_base.gemspec
+gemspec
+
+group :test do
+  gem 'enumerize'
+  gem 'simplecov'
+  gem 'sqlite3'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 akm
+
+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,75 @@
+# model_base_generators
+
+`model_base_generators` extends generators to use your models effectively.
+It uses twitter-bootstrap-rails, rspec, factory_girl and so on.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'model_base_generators'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### 1. Generate your model
+
+```bash
+$ bin/rails g model Issue project:references{required} title:string status:integer
+```
+
+### 2. Make up your generated migration
+
+Add `:null` option.
+
+```ruby
+class CreateIssues < ActiveRecord::Migration[5.0]
+  def change
+    create_table :issues do |t|
+      t.references :project, null: false, foreign_key: true
+      t.string :title  , null: false
+      t.integer :status, null: false
+
+      t.timestamps
+    end
+  end
+end
+```
+
+### 3. Run migration
+
+```bash
+$ bin/rails db:migrate
+```
+
+### 4. Generate controller and views
+
+```bash
+$ bin/rails g scaffold_controller issues
+```
+
+Run scaffold_controller **WITHOUT attributes**!
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akm/model_base_generators. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "model_base"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/model_base/column_attribute.rb

@@ -0,0 +1,77 @@
+require 'model_base'
+
+require 'rails/generators/generated_attribute'
+
+module ModelBase
+  class ColumnAttribute < ::Rails::Generators::GeneratedAttribute
+    attr_accessor :linkable
+    alias_method :linkable?, :linkable
+
+    attr_reader :reference
+    attr_reader :model, :column
+
+    def initialize(model, name, type, column: nil, reference: nil, index_type: false, attr_options: {})
+      super(name, type, index_type, attr_options)
+      @model = model
+      @reference = reference
+      @column = column
+    end
+
+    def ref_model
+      unless defined?(@ref_model)
+        @ref_model = reference.nil? ? nil : ModelBase::MetaModel.new(reference.class_name)
+      end
+      @ref_model
+    end
+
+    def required?
+      !column.try(:null)
+    end
+
+    def enumerized?
+      model.model_class.respond_to?(name) &&
+        defined?(Enumerize) && model.model_class.send(name).is_a?(Enumerize::Attribute)
+    end
+
+    def select_renderer
+      ref_model ? ReferenceSelectRenderer.new(self) :
+        enumerized? ? EnumerizedSelectRenderer.new(self) : nil
+    end
+
+    class AbstractSelectRenderer
+      attr_reader :column_attr
+      def initialize(column_attr)
+        @column_attr = column_attr
+      end
+
+      def render(form_name, target_name, options = {})
+        html = options.delete(:html) || {}
+        html_exp = html.empty? ? nil : html.inspect.gsub(/\A\{|\}\z/, '')
+        options.update(include_blank: !column_attr.required?)
+        options_exp = {}.inspect
+        r = render_core(form_name, target_name)
+        r << ", #{options_exp}"
+        r << ", #{html_exp}" unless html.empty?
+        r
+      end
+    end
+
+    class ReferenceSelectRenderer < AbstractSelectRenderer
+      def render_core(form_name, target_name, options = {})
+        ref_model = column_attr.ref_model
+        query =
+          ref_model.respond_to?(:choices_for) ?
+            "#{ref_model.name}.choices_for(#{taregt_name})" :
+            "#{ref_model.name}.all"
+        "#{form_name}.collection_select :#{column_attr.name}, #{query}, :id, :#{ref_model.title_column.name}"
+      end
+    end
+
+    class EnumerizedSelectRenderer < AbstractSelectRenderer
+      def render_core(form_name, target_name, options = {})
+        "#{form_name}.select :#{column_attr.name}, #{column_attr.model.name}.#{column_attr.name}.optoins"
+      end
+    end
+  end
+
+end

data/lib/model_base/config.rb

@@ -0,0 +1,21 @@
+require 'model_base'
+
+module ModelBase
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor(:disabled){ false }
+
+    config_accessor(:excluded_columns) do
+      [
+        /.*_checksum/,
+        /.*_count/,
+      ] + %w[_id _type id created_at updated_at]
+    end
+
+    config_accessor(:title_column_candidates) do
+      ['name', 'title', 'email', 'display_name', 'display_title', /_name\z/, /_title\z/]
+    end
+
+  end
+end

data/lib/model_base/generators/model_support.rb

@@ -0,0 +1,34 @@
+require 'model_base'
+
+require 'rails/generators'
+
+module ModelBase
+  module Generators
+    module ModelSupport
+      def self.included(klass)
+        klass.send :include, ::Rails::Generators::ResourceHelpers
+      end
+
+      def initialize(args, *options)
+        super(args, *options)
+        @model_name = (class_path + [@name.singularize.camelize]).join('::') unless @model_name
+        @model_name = @model_name.camelize
+      end
+
+      protected
+
+      def model
+        @model ||= ModelBase::MetaModel.new(@model_name)
+      end
+
+      def controller_routing_path
+        ActiveModel::Naming.route_key(@model_name.constantize)
+      end
+
+      def singular_controller_routing_path
+        ActiveModel::Naming.singular_route_key(@model_name.constantize)
+      end
+
+    end
+  end
+end

data/lib/model_base/meta_model.rb

@@ -0,0 +1,76 @@
+require "model_base"
+
+module ModelBase
+  class MetaModel
+
+    attr_reader :name
+    def initialize(name)
+      @name = name
+    end
+
+    alias_method :class_name, :name
+
+    def plural_name
+      name.pluralize
+    end
+
+    def resource_name
+      name.demodulize.underscore
+    end
+
+    def plural_resource_name
+      resource_name.pluralize
+    end
+
+    def full_resource_name
+      name.underscore.gsub('/', '_').sub(/\A_/, '')
+    end
+
+    def plural_full_resource_name
+      full_resource_name.pluralize
+    end
+
+    def columns
+      @columns ||= retrieve_columns.reject {|c| excluded?(c.name) }
+    end
+
+    def model_class
+      @model_class ||= name.constantize
+    end
+
+    def active_record?
+      defined?(ActiveRecord) == "constant" && ActiveRecord.class == Module && model_class < ActiveRecord::Base
+    end
+
+    def retrieve_columns
+      raw_cols = active_record? ? model_class.columns : model_class.fields.map {|c| c[1] }
+      belongs_to_refs = model_class.reflections.values.select{|ref| ref.is_a?(ActiveRecord::Reflection::BelongsToReflection) }
+      cols = raw_cols.map do |col|
+        ref = belongs_to_refs.detect{|ref| ref.foreign_key == col.name}
+        ColumnAttribute.new(self, col.name, col.type, reference: ref)
+      end
+      @title_column = nil
+      ModelBase.config.title_column_candidates.each do |tcc|
+        @title_column = cols.detect{|col| tcc === col.name}
+        break if @title_column
+      end
+      @title_column.linkable = true if @title_column
+      cols
+    end
+
+    def excluded?(name)
+      ModelBase.config.excluded_columns.any?{|c| c === name}
+    end
+
+    def title_column
+      retrieve_columns unless defined?(@title_column)
+      @title_column
+    end
+
+    def display_columns
+      @dispaly_columns ||=
+        title_column ? columns : [new_attribute(:id, :integer, true)] + columns
+    end
+
+  end
+end

data/lib/model_base/railtie.rb

@@ -0,0 +1,13 @@
+require 'model_base'
+
+module ModelBase
+  class Railtie < Rails::Railtie
+
+    generators do |g|
+      unless ModelBase.config.disabled
+        ModelBase.enable!
+      end
+    end
+
+  end
+end

data/lib/model_base/version.rb

@@ -0,0 +1,3 @@
+module ModelBase
+  VERSION = "0.1.0"
+end

data/lib/model_base.rb

@@ -0,0 +1,28 @@
+require "model_base/version"
+
+module ModelBase
+
+  autoload :ColumnAttribute, 'model_base/column_attribute'
+  autoload :Configuration, 'model_base/config'
+  autoload :MetaModel    , 'model_base/meta_model'
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def enable!
+      require 'model_base/generators/model_support'
+      ::Rails::Generators::NamedBase.prepend(::ModelBase::Generators::ModelSupport)
+      templates_dir = File::expand_path('../templates', __FILE__)
+      Rails::Generators.templates_path.unshift(templates_dir)
+      Rails::Generators.lookup(["rails:scaffold_controller"])
+      Rails::Generators::ScaffoldControllerGenerator.source_paths.unshift(templates_dir)
+    end
+  end
+end
+require 'model_base/railtie' if defined?(Rails)

data/lib/templates/api_controller.rb

@@ -0,0 +1,61 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
+
+  # GET <%= route_url %>
+  def index
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+
+    render json: <%= "@#{plural_table_name}" %>
+  end
+
+  # GET <%= route_url %>/1
+  def show
+    render json: <%= "@#{singular_table_name}" %>
+  end
+
+  # POST <%= route_url %>
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+
+    if @<%= orm_instance.save %>
+      render json: <%= "@#{singular_table_name}" %>, status: :created, location: <%= "@#{singular_table_name}" %>
+    else
+      render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      render json: <%= "@#{singular_table_name}" %>
+    else
+      render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def <%= "#{singular_table_name}_params" %>
+      <%- if attributes_names.empty? -%>
+      params.fetch(:<%= singular_table_name %>, {})
+      <%- else -%>
+      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      <%- end -%>
+    end
+end
+<% end -%>

data/lib/templates/controller.rb

@@ -0,0 +1,72 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  include Authentication
+  load_and_authorize_resource except: [:index]
+
+  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+
+  # GET <%= route_url %>
+  def index
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+  end
+
+  # GET <%= route_url %>/1
+  def show
+  end
+
+  # GET <%= route_url %>/new
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit
+  end
+
+  # POST <%= route_url %>
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+
+    if @<%= orm_instance.save %>
+      redirect_to @<%= singular_table_name %>, notice: <%= "'#{human_name} was successfully created.'" %>
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      redirect_to @<%= singular_table_name %>, notice: <%= "'#{human_name} was successfully updated.'" %>
+    else
+      render :edit
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+    redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %>
+  end
+
+  private
+
+  # Use callbacks to share common setup or constraints between actions.
+  def set_<%= singular_table_name %>
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+  end
+
+  # Only allow a trusted parameter "white list" through.
+  def <%= "#{singular_table_name}_params" %>
+    <%- if model.columns.empty? -%>
+    params[:<%= singular_table_name %>]
+    <%- else -%>
+    params.require(:<%= singular_table_name %>).permit(<%= model.columns.map { |c| ":#{c.name}" }.join(', ') %>)
+    <%- end -%>
+  end
+end
+<% end -%>

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

@@ -0,0 +1,40 @@
+<%%= form_for <%= model.full_resource_name %>, :html => { :class => "form-horizontal <%= model.full_resource_name %>" } do |f| %>
+
+  <%% if <%= model.full_resource_name %>.errors.any? %>
+    <div id="error_expl" class="panel panel-danger">
+      <div class="panel-heading">
+        <h3 class="panel-title"><%%= pluralize(<%= model.full_resource_name %>.errors.count, "error") %> prohibited this <%= model.full_resource_name %> from being saved:</h3>
+      </div>
+      <div class="panel-body">
+        <ul>
+        <%% <%= model.full_resource_name %>.errors.full_messages.each do |msg| %>
+          <li><%%= msg %></li>
+        <%% end %>
+        </ul>
+      </div>
+    </div>
+  <%% end %>
+
+<%- model.columns.each do |column| -%>
+  <div class="form-group">
+    <%%= f.label :<%= column.name %>, :class => 'control-label col-lg-2' %>
+    <div class="col-lg-10">
+  <%- if r = column.select_renderer -%>
+      <%%= <%= r.render('f', model.full_resource_name, html: {class: 'form-control'}) %> %>
+  <%- else -%>
+      <%%= f.<%= column.field_type %> :<%= column.name %>, :class => 'form-control' %>
+  <%- end -%>
+    </div>
+    <%%=f.error_span(:<%= column.name %>) %>
+  </div>
+  <%- end -%>
+
+  <div class="form-group">
+    <div class="col-lg-offset-2 col-lg-10">
+      <%%= f.submit nil, :class => 'btn btn-primary' %>
+      <%%= link_to t('.cancel', :default => t("helpers.links.cancel")),
+                <%= controller_routing_path %>_path, :class => 'btn btn-default' %>
+    </div>
+  </div>
+
+<%% end %>