ez-resources 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dadd125c3e79374bebeec76245b56d87f56060706dc2bf7622b546d3096ed319
+  data.tar.gz: 6beaea0d553ce0ae5ce008006ad0c7b435eb651a38709a69f976c87eb6e68e65
+SHA512:
+  metadata.gz: f67e74bba229bc0a2c7bce3be22f4ee8dfd3ef6e922aab1f1f69e9e6d49f2bafbd356a91773a8e9794c71d0980f6c65ca5f9cfb96f030ea1d67b0dcdd6ad1d65
+  data.tar.gz: 6dfc56195eb5877e94bd3b6d197679e7fb48ed5ae368d85eb1601de7be6292fdefadfba9d733f96bb3e348faa036105c39dac5f606742565bea83a282aeb798a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Volodya Sveredyuk
+
+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,106 @@
+# Ez::Resources
+CRUD is boring. As a rails developer, you are familiar with typical tasks as a list of records, create new records, update records and delete it if need it. Next will be pagination, maybe search and filtering. Every new project the same shit. Boring. Boring. Boring.
+
+I want to manage resources within fancy DSL that will do everything for me. Why? Because I can!
+
+## Usage
+
+### Router
+
+Use your rails router as it was used before. No hidden magic here
+```ruby
+# config/routes.rb
+
+resources :users
+
+```
+
+### Controller
+
+Are you familiar with rails controllers? Of course, you do. Use rails controllers as you already know but with the possibility to automate default workflows such as a collection, create, update or delete
+
+```ruby
+class UsersController < ApplicationController
+  # Include resource manager module
+  include Ez::Resources::Manager
+
+  # Now you have fancy DSL to manage your common workflows
+  ez_resource do |config|
+
+    # Set model class or it will try to guess it from controller name
+    # config.model = User
+
+    # Collection query or it will try to perfrom .all
+    # config.collection_query = -> (search_relation, ctx) { search_relation.where(user_id: ctx.params[:user_id]) }
+
+    # Single resource title presentation
+    # config.resource_label = :title
+
+    # Allow list of actions or default index, show, new, create, edit, update and destroy
+    # config.actions = %[index new update]
+
+    # Define default collection items
+    config.collection_columns do
+      column :email
+      column :active, type: :boolean
+      column :name,   type: :link, presenter: -> (user) { user.name.humanize }
+      column :age
+      column :avatar, type: :image,       getter:  ->(user) { "/avatars/#{user.id}.jpg" }, class: "t-image-tag"
+      column :custom, type: :custom,      builder: ->(user) { "custom #{user.email}" }
+      column :gender, type: :association, getter:  ->(user) { user.gender.upcase }
+      column :title,  type: :association, getter:  ->(user) { user.posts.pluck(:title) }, association: :posts, title: 'Post title'
+    end
+
+    # Add custom collection templates
+    # config.collection_views = [:table, :gallery]
+
+    # Form fields
+    config.form_fields do
+      field :email
+      field :name
+      field :active, type: :boolean, default: -> { true }
+      field :age,    type: :integer, default: -> { 18 }, required: false
+      field :gender, type: :select,  default: -> { 'Other' }, collection: %w(Male Female Other)
+    end
+
+    # Custom collection actions
+    config.collection_actions do
+      action :clone, proc { |_ctx, user| "/users/#{user.id}/clone" }, method: :post, class: 'custom-action-class'
+    end
+
+    # Hooks for authentication or any what you need
+    config.hooks do
+      add :can_update?, proc { |ctx, user| user.age >= 18 }
+    end
+  end
+end
+```
+
+### Enjoy
+That's all. More documentation coming soon ;)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ez-resources'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ez-resources
+```
+
+## TODO
+- [ ] Add generators for configuration and I18n
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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    = 'Ez::Resources'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/cells/ez/resources/application_cell.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Ez
+  module Resources
+    class ApplicationCell < Cell::ViewModel
+      self.view_paths = ["#{Ez::Resources::Engine.root}/app/cells", "#{::Rails.root}/app/cells/custom"]
+
+      CSS_SCOPE = 'ez-resources'
+
+      def self.form
+        include ActionView::Helpers::FormHelper
+        include ActionView::Helpers::DateHelper
+        include ActionView::Helpers::AssetTagHelper
+        include SimpleForm::ActionViewExtensions::FormHelper
+        include ActionView::RecordIdentifier
+        include ActionView::Helpers::FormOptionsHelper
+      end
+
+      def div_for(item, extra = nil, &block)
+        content_tag :div, class: css_for(item, extra), &block
+      end
+
+      def css_for(item, extra = nil)
+        scoped_item = "#{CSS_SCOPE}-#{item}"
+
+        css_class = custom_css_map[scoped_item] || scoped_item
+
+        extra ? "#{css_class} #{extra}" : css_class
+      end
+
+      def custom_css_map
+        @custom_css_map ||= Ez::Resources.config.ui_custom_css_map || {}
+      end
+
+      def t(args)
+        I18n.t(args, scope: Ez::Resources.config.i18n_scope)
+      end
+    end
+  end
+end

data/app/cells/ez/resources/collection/table.slim

@@ -0,0 +1,42 @@
+= div_for 'container'
+  = div_for 'collection-container'
+    = div_for 'collection-inner-container'
+      = div_for 'collection-top-container'
+        = div_for 'collection-header-container'
+          h2 class=(css_for('header-label')) = header_text
+
+        = div_for 'collection-actions-container'
+          = div_for 'actions-inner-container'
+            - if  model.collection_views.present?
+              - model.collection_views.each do |view_name|
+                = view_switch_link(view_name)
+            = new_link
+
+      = div_for 'collection-table-container'
+        table class=(css_for 'collection-table')
+          thead class=(css_for 'collection-table-thead')
+            tr class=(css_for 'collection-table-thead-tr')
+              - collection_columns.each do |column|
+                th class=(css_for 'collection-table-thead-th') id=("ez-t-#{column.name}") = column.title
+              th class=(css_for 'collection-table-thead-th') colspan="2" style="width: 1%"
+          tbody class=(css_for 'collection-table-tbody')
+            - collection.each do |record|
+              = record_tr record do
+                - collection_columns.each do |column|
+                  td class=(css_for 'collection-table-td', "ez-t-#{column.name}")
+                    = record_column_value(record, column)
+                td class=(css_for 'collection-table-td-actions')
+                  = div_for 'collection-table-td-actions-container' do
+                    i class=(css_for('collection-table-actions-icon'))
+                    = div_for 'collection-table-td-actions-content' do
+                      = show_link(record)
+                      = edit_link(record)
+                      = remove_link(record)
+                      - model.collection_actions.each do |custom_action|
+                        = link_to t("actions.#{custom_action.name}"), custom_action.builder.call(controller, record), custom_action.options.merge(class: css_for('collection-table-td-action-item'))
+
+        - if paginator && paginator.count > 20
+          == pagination
+
+  - if model.collection_search?
+    = cell 'ez/resources/search', model

data/app/cells/ez/resources/collection_cell.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Ez
+  module Resources
+    class CollectionCell < ApplicationCell
+      include Pagy::Frontend
+
+      delegate :resources_name, :collection_columns, :paginator, to: :model
+
+      def show
+        if model.params[:view]
+          render params[:view]
+        else
+          render :table
+        end
+      end
+
+      def collection
+        @collection ||= model.data
+      end
+
+      def header_text
+        resources_name
+      end
+
+      def record_column_value(record, column)
+        result = if column.type == :association
+                   column.getter.call(record)
+                 elsif column.type == :boolean
+                   maybe_use_custom_boolean_presenter(record.public_send(column.name))
+                 elsif column.type == :custom
+                   column.builder.call(record)
+                 elsif column.type == :image
+                   url = column.getter.call(record)
+
+                   image_tag url, column.options if url
+                 elsif column.type == :link
+                   as_a_link(record, column)
+                 else
+                   record.public_send(column.name)
+                end
+
+        result = column.presenter.call(record) if column.presenter
+        result
+      end
+
+      def record_tr(record, &block)
+        if model.actions.include?(:show) && Manager::Hooks.can?(:can_read?, model, record)
+          content_tag :tr, class: css_for('collection-table-tr'), id: "#{resources_name.downcase}-#{record.id}", data: { link: model.path_for(action: :show, id: record.id).to_s }, &block
+        else
+          content_tag :tr, class: css_for('collection-table-tr'), id: "#{resources_name.downcase}-#{record.id}", &block
+        end
+      end
+
+      def new_link
+        return unless model.actions.include?(:new)
+        return unless Manager::Hooks.can?(:can_create?, model)
+
+        link_to t('actions.add'), model.path_for(action: :new), class: css_for('actions-new-link')
+      end
+
+      def show_link(record)
+        return unless model.actions.include?(:show)
+        return unless Manager::Hooks.can?(:can_read?, model, record)
+
+        link_to t('actions.show'), model.path_for(action: :show, id: record.id), class: css_for('collection-table-td-action-item')
+      end
+
+      def as_a_link(record, column)
+        return unless model.actions.include?(:show)
+        return unless Manager::Hooks.can?(:can_read?, model, record)
+
+        link_to record.public_send(column.name), model.path_for(action: :show, id: record.id)
+      end
+
+      def edit_link(record)
+        return unless model.actions.include?(:edit)
+        return unless Manager::Hooks.can?(:can_read?, model, record)
+
+        link_to t('actions.edit'), model.path_for(action: :edit, id: record.id), class: css_for('collection-table-td-action-item')
+      end
+
+      def remove_link(record)
+        # TODO
+      end
+
+      def pagination
+        if Ez::Resources.config.pagination_method
+          instance_exec paginator, &Ez::Resources.config.pagination_method
+        else
+          pagy_nav(paginator)
+        end
+      end
+
+      def view_switch_link(view_name)
+        return unless model.collection_views.present?
+
+        params = model.params.to_unsafe_hash.slice(:q, :page, :s).symbolize_keys.merge(view: view_name)
+        selected = css_for('collection-view-selected-link') if model.params[:view] == view_name.to_s
+
+        link_to model.path_for(action: :index, params: params), id: "ez-view-#{view_name}", class: css_for("collection-view-link-#{view_name}", selected) do
+          content_tag :i, nil, class: css_for("collection-view-link-#{view_name}-icon")
+        end
+      end
+
+      private
+
+      def maybe_use_custom_boolean_presenter(bool)
+        return bool unless Ez::Resources.config.ui_custom_boolean_presenter
+
+        instance_exec bool, &Ez::Resources.config.ui_custom_boolean_presenter
+      end
+    end
+  end
+end

data/app/cells/ez/resources/field/show.slim

@@ -0,0 +1,2 @@
+= div_for "form-field-#{model.type}-type"
+  = options[:form].input model.name, html_options

data/app/cells/ez/resources/field_cell.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Ez
+  module Resources
+    class FieldCell < ApplicationCell
+      def html_options
+        if options[:new_record?]
+          base_options.merge(
+            selected:   model.default&.call,
+            input_html: {
+              value:   model.default&.call,
+              checked: model.default&.call
+            }
+          )
+        else
+          base_options
+        end
+      end
+
+      def base_options
+        {
+          label:           model.title,
+          as:              model.type,
+          collection:      model.collection,
+          include_blank:   model.required?,
+          required:        model.required?,
+          readonly:        options[:readonly],
+          checked_value:   true.to_s,
+          unchecked_value: false.to_s,
+          wrapper:         model.wrapper,
+          right_label:     model.suffix,
+          input_html:      {
+            min: model.min
+          }
+        }.merge(model.options)
+      end
+
+      # TODO: add default value in case of new record
+    end
+  end
+end

data/app/cells/ez/resources/form/show.slim

@@ -0,0 +1,16 @@
+= div_for 'container'
+  = div_for 'form-container'
+    = div_for 'form-header-container'
+      = div_for 'header-inner-container'
+        h2 class=(css_for('header-label')) = form_header_label
+
+    = div_for 'form-inner-container'
+      = simple_form_for model.data, as: :ez_resource, html: { readonly: readonly? } do |f|
+        - model.form_fields.each do |field|
+          = cell 'ez/resources/field', field, form: f, new_record?: model.data.new_record?, readonly: readonly?
+
+        = div_for 'form-actions'
+          - unless readonly?
+            = f.submit submit_button_text, class: css_for('actions-submit-button')
+
+          = link_to t('actions.cancel'), model.path_for(action: :index)

data/app/cells/ez/resources/form_cell.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Ez
+  module Resources
+    class FormCell < ApplicationCell
+      form
+
+      def form_header_label
+        if model.data.new_record?
+          "#{t('actions.new')} #{model.resource_name.downcase}"
+        else
+          "#{t('actions.edit')} #{model.data.public_send(model.resource_label)} #{model.resource_name.downcase}"
+        end
+      end
+
+      def readonly?
+        @readonly ||= if model.data.new_record?
+                        !Ez::Resources::Manager::Hooks.can?(:can_create?, model, model.data)
+                      else
+                        !Ez::Resources::Manager::Hooks.can?(:can_update?, model, model.data)
+                      end
+      end
+
+      def submit_button_text
+        if model.data.new_record?
+          t('actions.create')
+        else
+          t('actions.update')
+        end
+      end
+    end
+  end
+end