rails-add_ons 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 963bb8277207578ae5916394485eb2adb8c0e8ea
+  data.tar.gz: 1ab4b5ac4548ec0f88f66cf99ab712c22d88f331
+SHA512:
+  metadata.gz: e7e66a7c872436641d6f8e28c2b23d891d3b2c0122153e68ad57b2ab9817d56239d00dd42ceeec001c337740c371201db922c233ee3e27be0ea8a13896a664a2
+  data.tar.gz: d09be621db5157cac495193403b0e8e88f9672c3b424f0aefdc1f0e14163db67e5ccb478c79b9fefa3d9e563efbe6ee089749ca22c0b98d6f97df1d229ad225a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Roberto Vasquez Angel
+
+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,28 @@
+# Rails::AddOns
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-add_ons'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails-add_ons
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,24 @@
+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    = 'Rails::AddOns'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/javascripts/rails/add_ons/application/widgets.js.coffee

@@ -0,0 +1,48 @@
+class window.WidgetReloader
+  constructor: (container_id, widget_name, widget_action)->
+    @container_id = container_id
+    @widget_name = widget_name
+    @widget_action = widget_action
+
+  reload: ->
+    console.log "Loading #{this.container_id}"
+    $("##{this.container_id}").html("Loading...")
+    $.ajax
+      context: this
+      type: 'POST'
+      url: this.uri()
+      headers:
+        Accept: 'application/json'
+        'X-CSRF-Token': this.csrf_token()
+      success: (data) ->
+        $("##{this.container_id}").html data
+        return
+      error: (jqXHR) ->
+        msg = 'Sorry but there was an error: '
+        $("##{this.container_id}").html msg + jqXHR.status + ' ' + jqXHR.statusText
+        return
+
+  csrf_token: ->
+    $('meta[name=\'csrf-token\']').attr('content')
+
+  encoded_widget_action_and_name: ->
+    encodeURIComponent("#{this.widget_name}##{this.widget_action}")
+
+  encoded_widget_action: ->
+    encodeURIComponent(this.widget_action)
+
+  base_path: ->
+    $('meta[name=\'widget-base-path\']').attr('content')
+
+  uri: ->
+    "#{this.base_path()}/#{this.encoded_widget_action_and_name()}"
+
+$(document).ready ->
+  $('body').on 'click', "*[data-refresh]", ->
+    button_id = $(this).attr('id')
+    container_id = $(this).attr('data-refresh')
+    widget_name = $("##{container_id}").attr('data-widget')
+    widget_action = $("##{container_id}").attr('data-widgetaction')
+    wr = new window.WidgetReloader(container_id, widget_name, widget_action)
+    wr.reload()
+    return

data/app/assets/javascripts/rails/add_ons/application.js

@@ -0,0 +1,17 @@
+// 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require tether
+//= require bootstrap-sprockets
+//= require_tree ./application

data/app/assets/javascripts/rails_add_ons.js

@@ -0,0 +1 @@
+//= require rails/add_ons/application

data/app/assets/stylesheets/rails/add_ons/application/bootstrap_overrides.scss

@@ -0,0 +1,3 @@
+body {
+  padding-top: 80px;
+}

data/app/assets/stylesheets/rails/add_ons/application/table_monospaced.scss

@@ -0,0 +1,3 @@
+.table-monospaced {
+  font-family: monospace;
+}

data/app/assets/stylesheets/rails/add_ons/application/widgets.scss

@@ -0,0 +1,5 @@
+.widget-controls {
+  position: absolute;
+  top: 0px;
+  right: 0px;
+}

data/app/assets/stylesheets/rails/add_ons/application.scss

@@ -0,0 +1,4 @@
+@import "application/bootstrap_overrides";
+@import "application/table_monospaced";
+@import "application/widgets";
+@import "bootstrap";

data/app/assets/stylesheets/rails/add_ons/bootstrap_v3_flex_extension.scss

@@ -0,0 +1,13 @@
+.flex-row {
+  display: flex;
+  flex-direction: row;
+  flex-wrap: wrap;
+}
+
+.flex-row div[class^="col-"] {
+   display: flex;
+}
+
+.flex-row div[class^="col-"] > * {
+  width: 100%;
+}

data/app/assets/stylesheets/rails/add_ons/font_awesome.css

@@ -0,0 +1,3 @@
+/*
+ *= require rails/add_ons/application
+ */

data/app/assets/stylesheets/rails_add_ons.css

@@ -0,0 +1,3 @@
+/*
+ *= require rails/add_ons/application
+ */

data/app/caches/api/cache.rb

@@ -0,0 +1,24 @@
+module Api
+  class Cache
+    def self.cache(options = {}, &block)
+      instance = new(options = {})
+      instance.prepare_cache(&block)
+      instance
+    end
+
+    def initialize(options = {}, &block)
+    end
+
+    def prepare_cache(&block)
+      @cachable = block
+    end
+
+    def method_missing(m, *args, &block)
+      key = "#{m}-#{args.to_json}-#{block.to_json}"
+      # raise key
+      output = @cachable.call.send(m, *args, &block)
+      # raise output.inspect
+      output
+    end 
+  end
+end

data/app/components/component/base.rb

@@ -0,0 +1,24 @@
+module Component
+  class Base
+    def initialize(view, options = {}, &block)
+      @view        = view
+      @block       = block
+      @options     = options
+      @view_locals = {}
+    end
+
+    def perform
+      @block_output = block_output
+      @view.render partial: self.class.name.underscore, locals: view_locals
+    end
+
+    private
+
+    attr_reader :view_locals
+
+    def block_output
+      return unless @block.present?
+      @view.capture { @block.call(self) }
+    end
+  end
+end

data/app/components/component/collection_table.rb

@@ -0,0 +1,80 @@
+module Component
+  class CollectionTable < Base
+    SIZE_MAP = {
+      default: nil,
+      small:   :sm
+    }
+
+    def initialize(*args)
+      super
+      @columns        = {}
+      @collection     = @options.delete(:collection)
+      @resource_class = @collection.first.class
+    end
+
+    def column(name, options = {}, &block)
+      options.reverse_merge!(block: block) if block_given?
+      @columns[name] = options
+    end
+
+    def timestamps
+      column(:created_at)
+      column(:updated_at)
+    end
+
+    def association(name, options = {}, &block)
+      options.reverse_merge!(block: block) if block_given?
+      @columns[name] = options
+    end
+
+    private
+
+    def table
+      self
+    end
+
+    def view_locals
+      {
+        columns:           @columns,
+        collection:        @collection,
+        resource_class:    @resource_class,
+        table_css_classes: table_css_classes
+      }
+    end
+
+    def striped?
+      !!@options[:striped]
+    end
+
+    def responsive?
+      !!@options[:responsive]
+    end
+
+    def inverse?
+      !!@options[:inverse]
+    end
+
+    def bordered?
+      !!@options[:bordered]
+    end
+
+    def hover?
+      !!@options[:hover]
+    end
+
+    def size
+      SIZE_MAP[@options[:size] || :default]
+    end
+
+    def table_css_classes
+      classes = ['table']
+      classes << 'table-bordered'   if bordered?
+      classes << 'table-hover'      if hover?
+      classes << 'table-inverse'    if inverse?
+      classes << 'table-striped'    if striped?
+      classes << 'table-responsive' if responsive?
+      classes << "table-#{size}"    if size.present?
+      classes
+    end
+  end
+end

data/app/components/component/resource_table.rb

@@ -0,0 +1,25 @@
+module Component
+  class ResourceTable < Base
+    def initialize(*args)
+      super
+      @rows           = {}
+      @resource       = @options.delete(:resource)
+      @resource_class = @resource.class
+    end
+
+    def row(name, options = {}, &block)
+      options.reverse_merge!(block: block) if block_given?
+      @rows[name] = options
+    end
+
+    private
+
+    def view_locals
+      {
+        rows:           @rows,
+        resource:       @resource,
+        resource_class: @resource_class
+      }
+    end
+  end
+end

data/app/concerns/api_controller_concerns/exception_handling.rb

@@ -0,0 +1,24 @@
+module ApiControllerConcerns
+  module ExceptionHandling
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from Exception do |exception|
+        if Rails.env.development? || Rails.env.test?
+          error = { message: exception.message }
+
+          error[:application_trace] = Rails.backtrace_cleaner.clean(exception.backtrace)
+          error[:full_trace] = exception.backtrace 
+
+          respond_to do |format|
+            format.json { render json: error, status: 500 }
+          end
+        else
+          respond_to do |format|
+            format.json { render json: { error: 'Internal server error.' }, status: 500 }
+          end
+        end
+      end
+    end
+  end
+end

data/app/concerns/resources_controller/pagination.rb

@@ -0,0 +1,15 @@
+module ResourcesController::Pagination
+  def self.included(base)
+    base.helper_method :paginate?
+  end
+
+  def paginate?
+    true
+  end
+
+  private
+
+  def load_collection
+    @collection = load_collection_scope.page(params[:page])
+  end
+end

data/app/concerns/resources_controller/sorting.rb

@@ -0,0 +1,15 @@
+module ResourcesController::Sorting
+  private
+
+  def load_collection_scope
+    add_order_scope(super)
+  end
+
+  def add_order_scope(base_scope)
+    if params[:sort_by].present?
+      base_scope.order(params[:sort_by] => (params[:sort_direction] || :asc))
+    else
+      base_scope
+    end
+  end
+end

data/app/controllers/api/resources_controller/base.rb

@@ -0,0 +1,254 @@
+module Api
+  module ResourcesController
+    class Base < ::ApiController
+      module RestActions
+        extend ActiveSupport::Concern
+
+        included do
+          include ActionController::MimeResponds
+
+          respond_to :json
+
+          if respond_to?(:before_action)
+            before_action :load_collection, only: [:index]
+            before_action :load_resource_for_show, only: [:show]
+            before_action :load_resource, only: [:update, :destroy, :delete]
+            before_action :initialize_resource_for_create, only: [:create]
+          else
+            before_filter :load_collection, only: [:index]
+            before_filter :load_resource_for_show, only: [:show]
+            before_filter :load_resource, only: [:update, :destroy, :delete]
+            before_filter :initialize_resource_for_create, only: [:create]
+          end
+        end
+
+        def index
+          respond_to do |format|
+            format.json { render json: serialize_collection(@collection) }
+          end
+        end
+
+        def show
+          respond_to do |format|
+            if @resource.nil?
+              format.json { render json: { error: "Couldn't find #{resource_class} with ID=#{params[:id]}" }, status: :not_found }
+            else
+              format.json { render json: serialize_resource(@resource), status: :ok }
+            end
+          end
+        end
+
+        def create
+          respond_to do |format|
+            if @resource.save
+              format.json { render json: serialize_resource(@resource), status: :created }
+            else
+              format.json { render json: { errors: serialize_errors(@resource.errors) }, status: 422 }
+            end
+          end
+        end
+
+        def update
+          respond_to do |format|
+            if @resource.update_attributes(permitted_params)
+              format.json { render json: serialize_resource(@resource) }
+            else
+              format.json { render json: { errors: serialize_errors(@resource.errors) }, status: 422 }
+            end
+          end
+        end
+
+        def destroy
+          @resource.destroy
+          respond_to do |format|
+            format.json { render json: serialize_resource(@resource) }
+          end
+        end
+
+        def delete
+          @resource.delete
+          respond_to do |format|
+            format.json { render json: serialize_resource(@resource) }
+          end
+        end
+
+        private
+
+        def load_collection
+          base_scope = resource_class
+          scope = add_conditions_from_query(base_scope)
+          @collection = scope.all
+        end
+
+        def load_resource
+          @resource = resource_class.find(params[:id])
+        end
+
+        def load_resource_for_show
+          begin
+            @resource = resource_class.find(params[:id])
+          rescue ActiveRecord::RecordNotFound
+            @resource = nil
+          end
+        end
+
+        def initialize_resource
+          @resource = resource_class.new
+        end
+
+        def initialize_resource_for_create
+          @resource = resource_class.new(permitted_params)
+        end
+
+        def permitted_params
+          raise "not implemented"
+        end
+      end
+
+      module QueryConditions
+        private
+
+        def add_conditions_from_query(scope)
+          request.query_parameters.each do |field, condition|
+            case field
+            when 'limit'
+              scope = scope.limit(condition)
+            when 'offset'
+              scope = scope.offset(condition)
+            when 'order'
+              scope = scope.order(condition)
+            when 'includes'
+              scope = scope.includes(condition.to_sym)
+            else
+              condition_statement = ::Api::ResourcesController::ConditionParser.new(field, condition).condition_statement
+              scope = scope.where(condition_statement)
+            end
+          end
+          scope
+        end
+      end
+
+      include QueryConditions
+
+      module Resources
+        extend ActiveSupport::Concern
+
+        def resource_class
+          self.class.resource_class
+        end
+      end
+
+      module RestResourceUrls
+        extend ActiveSupport::Concern
+
+        private
+
+        def resource_url(resource)
+          url_for(action: :show, id: resource.to_param)
+        end
+      end
+
+      module Serialization
+        private
+
+        def serialize_collection(collection)
+          collection.collect do |resource|
+            json = resource.as_json
+            json[:errors] = serialize_errors(resource.errors) if resource.errors.any?
+            json
+          end
+        end
+
+        def serialize_resource(resource)
+          json = resource.as_json
+          json[:errors] = serialize_errors(resource.errors) if resource.errors.any?
+          json
+        end
+
+        def serialize_errors(errors)
+          errors.as_json(full_messages: true)
+        end
+      end
+
+      module CountAction
+        extend ActiveSupport::Concern
+
+        included do
+          if respond_to?(:before_action)
+            before_action :load_count, only: [:count]
+          else
+            before_filter :load_count, only: [:count]
+          end
+        end
+
+        def count
+          respond_to do |format|
+            format.json { render json: { count: @count } }
+          end
+        end
+
+        private
+
+        def load_count
+          @count = resource_class.count
+        end
+      end
+
+      module DestroyAllAction
+        extend ActiveSupport::Concern
+
+        included do
+          if respond_to?(:before_action)
+            before_action :load_and_destroy_collection, only: [:destroy_all]
+          else
+            before_filter :load_and_destroy_collection, only: [:destroy_all]
+          end
+        end
+
+        def destroy_all
+          respond_to do |format|
+            format.json { render json: serialize_collection(@collection) }
+          end
+        end
+
+        private
+
+        def load_and_destroy_collection
+          @collection = resource_class.destroy_all
+        end
+      end
+
+      module DeleteAllAction
+        extend ActiveSupport::Concern
+
+        included do
+          if respond_to?(:before_action)
+            before_action :delete_collection, only: [:delete_all]
+          else
+            before_filter :delete_collection, only: [:delete_all]
+          end
+        end
+
+        def delete_all
+          respond_to do |format|
+            format.json { render json: { count: @count } }
+          end
+        end
+
+        private
+
+        def delete_collection
+          @count = resource_class.delete_all
+        end
+      end
+      include RestActions
+      include Resources
+      include RestResourceUrls
+      include Serialization
+      include CountAction
+      include DestroyAllAction
+      include DeleteAllAction
+      include ApiControllerConcerns::ExceptionHandling
+    end
+  end
+end