pg_scaffold 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be584e1438bc8ed756bb2e21c5bca90219d1f86d9831cfba0e47dda2b3d030d6
+  data.tar.gz: 3e7d8bcfdbc072b647d984e7ca6aaaedfe8e5e0f51c05af68015cfd663a10909
+SHA512:
+  metadata.gz: 93f78f44c14d68de6a5706fab890b2f0913838f79f1a20e455b9672ef0f4e7cafd9bc1921e19e54c8352c2fdf836ef8f25849b4b9a18d6a43a40d978f155608e
+  data.tar.gz: 1745e48cd3ccc7915bfb7a929393f46f232e9f2721218b85309f46f74028246658dc8c9a6f33afa8652b0d35ba596dad33a59f0dd6a8bb09e373321f23dd1c42

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Martín Rosso
+
+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 @@
+# PgScaffold
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pg_scaffold"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install pg_scaffold
+```
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/generators/pg_active_record/model/model_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record/model/model_generator'
+
+module PgActiveRecord
+  class ModelGenerator < ActiveRecord::Generators::ModelGenerator
+    source_paths << File.expand_path('templates', __dir__)
+
+    class_option :paranoia, type: :boolean, default: false, desc: 'Paranoid y deleted_at.'
+    class_option :discard, type: :boolean, default: false, desc: 'Discard y discarded_at.'
+    class_option :trackeo_de_usuarios, type: :boolean, default: true,
+                                       desc: 'Genera campos creado_por y actualizado_por.'
+
+    def namespace # :doc:
+      nil
+    end
+    def class_path # :doc:
+      []
+    end
+    def create_module_file
+    end
+  end
+end

data/lib/generators/pg_active_record/model/templates/create_table_migration.rb.tt

@@ -0,0 +1,46 @@
+# generado con pg_rails
+
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :<%= table_name %><%= primary_key_type %> do |t|
+<% attributes.each do |attribute| -%>
+<% if attribute.password_digest? -%>
+      t.string :password_digest<%= attribute.inject_options %>
+<% elsif attribute.token? -%>
+      t.string :<%= attribute.name %><%= attribute.inject_options %>
+<% else -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% end -%>
+
+<% if options[:trackeo_de_usuarios] %>
+      t.references :creado_por, index: true
+      t.references :actualizado_por, index: true
+
+<% end -%>
+<% if options[:paranoia] %>
+      t.datetime :deleted_at
+<% end -%>
+<% if options[:discard] %>
+      t.datetime :discarded_at
+<% end -%>
+<% if options[:timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+<% attributes.select(&:token?).each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
+<% end -%>
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+<% attributes.select(&:tiene_nombre_de_clase_explicito?).each do |attribute| -%>
+    add_foreign_key :<%= table_name %>, :<%= attribute.tabla_referenciada %>, column: '<%= attribute.name %>_id'
+<% end -%>
+
+<% if options[:trackeo_de_usuarios] %>
+    add_foreign_key :<%= table_name %>, :users, column: 'creado_por_id'
+    add_foreign_key :<%= table_name %>, :users, column: 'actualizado_por_id'
+<% end -%>
+  end
+end

data/lib/generators/pg_active_record/model/templates/migration.rb.tt

@@ -0,0 +1,48 @@
+# generado con pg_rails
+
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+<%- if migration_action == 'add' -%>
+  def change
+<% attributes.each do |attribute| -%>
+  <%- if attribute.reference? -%>
+    add_reference :<%= table_name %>, :<%= attribute.name %><%= attribute.inject_options %>
+  <%- elsif attribute.token? -%>
+    add_column :<%= table_name %>, :<%= attribute.name %>, :string<%= attribute.inject_options %>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
+  <%- else -%>
+    add_column :<%= table_name %>, :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %>
+    <%- if attribute.has_index? -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+    <%- end -%>
+  <%- end -%>
+<%- end -%>
+  end
+<%- elsif migration_action == 'join' -%>
+  def change
+    create_join_table :<%= join_tables.first %>, :<%= join_tables.second %> do |t|
+    <%- attributes.each do |attribute| -%>
+      <%- if attribute.reference? -%>
+      t.references :<%= attribute.name %><%= attribute.inject_options %>
+      <%- else -%>
+      <%= '# ' unless attribute.has_index? -%>t.index <%= attribute.index_name %><%= attribute.inject_index_options %>
+      <%- end -%>
+    <%- end -%>
+    end
+  end
+<%- else -%>
+  def change
+<% attributes.each do |attribute| -%>
+<%- if migration_action -%>
+  <%- if attribute.reference? -%>
+    remove_reference :<%= table_name %>, :<%= attribute.name %><%= attribute.inject_options %>
+  <%- else -%>
+    <%- if attribute.has_index? -%>
+    remove_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+    <%- end -%>
+    remove_column :<%= table_name %>, :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %>
+  <%- end -%>
+<%- end -%>
+<%- end -%>
+  end
+<%- end -%>
+end

data/lib/generators/pg_active_record/model/templates/model.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# generado con pg_rails
+
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_record"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+  audited
+  <%- if options[:paranoia] -%>
+  acts_as_paranoid without_default_scope: true
+  <%- end -%>
+  <%- if options[:discard] -%>
+  include Discard::Model
+  <%- end -%>
+  <%- if attributes.any?(&:reference?) -%>
+
+    <%- attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %><%= ', optional: true' unless attribute.required? %><%= ", class_name: '#{attribute.clase_con_modulo}'" if attribute.tiene_nombre_de_clase_explicito? %>
+    <%- end -%>
+  <%- end -%>
+  <%- if options[:trackeo_de_usuarios] -%>
+
+  belongs_to :creado_por, optional: true, class_name: 'User'
+  belongs_to :actualizado_por, optional: true, class_name: 'User'
+  <%- end -%>
+  <%- if attributes.any?(&:es_enum?) -%>
+
+    <%- attributes.select(&:es_enum?).each do |attribute| -%>
+  enumerize :<%= attribute.name %>, in: { completar: 0, los: 1, valores: 2 }
+    <%- end -%>
+  <%- end -%>
+  <%- if attributes.any?(&:required?) -%>
+
+  validates <%= attributes.select(&:required?).map { |at| ":#{at.name}" }.join(', ') %>, presence: true
+  <%- end -%>
+  <%- attributes.select(&:token?).each do |attribute| -%>
+  has_secure_token<% if attribute.name != "token" %> :<%= attribute.name %><% end %>
+  <%- end -%>
+  <%- if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+  <%- end -%>
+end
+<% end -%>

data/lib/generators/pg_active_record/model/templates/module.rb

@@ -0,0 +1,9 @@
+# generado con pg_rails
+
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+  def self.table_name_prefix
+    '<%= namespaced? ? namespaced_class_path.join('_') : class_path.join('_') %>_'
+  end
+end
+<% end -%>

data/lib/generators/pg_decorator/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate pg_decorator Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/pg_decorator/pg_decorator_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'generators/rails/decorator_generator'
+
+class PgDecoratorGenerator < Rails::Generators::DecoratorGenerator
+  source_root File.expand_path('templates', __dir__)
+
+  remove_hook_for :test_framework
+
+  def namespace # :doc:
+    nil
+  end
+
+  def class_path # :doc:
+    []
+  end
+  def create_module_file
+  end
+
+  private
+
+    def class_path_original
+      @class_path.first
+    end
+
+
+    def parent_class_name
+      'PgRails::BaseDecorator'
+    end
+end

data/lib/generators/pg_decorator/templates/decorator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# generado con pg_rails
+
+<%- module_namespacing do -%>
+  <%- if parent_class_name.present? -%>
+class <%= class_name %>Decorator < <%= parent_class_name %>
+  <%- else -%>
+class <%= class_name %>
+  <%- end -%>
+  delegate_all
+
+  <%- if class_path_original.present? -%>
+  def default_module
+    :admin
+  end
+  <%- end -%>
+
+  # Define presentation-specific methods here. Helpers are accessed through
+  # `helpers` (aka `h`). You can override attributes, for example:
+  #
+  #   def created_at
+  #     helpers.content_tag :span, class: 'time' do
+  #       object.created_at.strftime("%a %m/%d/%y")
+  #     end
+  #   end
+end
+<% end -%>

data/lib/generators/pg_factory_bot/model/model_generator.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# este generator tiene que llamarse ModelGenerator para que funcione el hook_to
+# del ModelGenerator de rails
+
+require 'generators/factory_bot/model/model_generator'
+
+module PgFactoryBot
+  module Generators
+    class ModelGenerator < FactoryBot::Generators::ModelGenerator
+      # piso el método de FactoryBot::Generators::Base con el método original
+      # de Rails::Generators::Base
+
+      # rubocop:disable Naming/MemoizedInstanceVariableName
+      def self.source_root(path = nil)
+        @_source_root = path if path
+        @_source_root ||= default_source_root
+      end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+
+      source_root File.expand_path('templates', __dir__)
+
+      class_option(
+        :dir,
+        type: :string,
+        default: 'spec/factories',
+        desc: 'The directory or file root where factories belong'
+      )
+
+      # Los modelos nunca tienen modulo
+      def explicit_class_option
+      end
+
+      def namespace # :doc:
+        nil
+      end
+      def class_path # :doc:
+        []
+      end
+      def create_module_file
+      end
+
+      private
+
+#{factory_attributes.gsub(/^/, '    ')}#{los_traits.gsub(/^/, '    ')}
+        def factory_definition
+<<~RUBY
+  factory :#{singular_table_name}#{explicit_class_option} do
+#{factory_attributes}#{los_traits}
+  end
+RUBY
+        end
+
+        def los_traits
+          ret = attributes.select(&:reference?).map do |atributo|
+            {
+              clase: atributo.clase_con_modulo,
+              atributo_name: atributo.name,
+            }
+          end
+        end
+
+        # Genero los valores de las factories con los helpers de Faker
+
+        def factory_attributes
+          attributes.map do |attribute|
+            if attribute.reference?
+              # "association :#{attribute.name}, factory: :#{attribute.tabla_referenciada_singular}"
+              attribute.name
+            else
+              "#{attribute.name} { #{valor_atributo(attribute)} }"
+            end
+          end
+        end
+
+        def valor_atributo(attribute)
+          if attribute.es_enum?
+            "#{nombre_clase_completo}.#{attribute.name}.values.sample"
+          elsif attribute.type == :string
+            'Faker::Lorem.sentence'
+          elsif attribute.type == :date
+            'Faker::Date.backward'
+          elsif attribute.type == :float || attribute.type == :decimal
+            'Faker::Number.decimal(l_digits: 3, r_digits: 2)'
+          elsif attribute.type == :integer
+            'rand(1..9999)'
+          else
+            attribute.default.inspect
+          end
+        end
+    end
+  end
+end

data/lib/generators/pg_factory_bot/model/templates/factories.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# generado con pg_rails
+
+FactoryBot.define do
+  factory :<%= singular_table_name %> do<% factory_attributes.each do |a| %>
+    <%= a %><% end %><% los_traits.each do |trait| %>
+
+    trait :<%= trait[:atributo_name] %>_existente do
+      <%= trait[:atributo_name] %> { nil }
+      <%= trait[:atributo_name] %>_id { <%= trait[:clase] %>.pluck(:id).sample }
+    end<% end %>
+  end
+end

data/lib/generators/pg_pundit/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate pg_pundit Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/pg_pundit/pg_pundit_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'generators/pundit/policy/policy_generator'
+
+class PgPunditGenerator < Pundit::Generators::PolicyGenerator
+  source_root File.expand_path('templates', __dir__)
+
+  remove_hook_for :test_framework
+
+  def namespace # :doc:
+    nil
+  end
+  def class_path # :doc:
+    []
+  end
+  def create_module_file
+  end
+end

data/lib/generators/pg_pundit/templates/policy.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# generado con pg_rails
+
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_policy"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= class_name %>Policy < ApplicationPolicy
+  class Scope < ApplicationPolicy::Scope
+    # def resolve
+    #   if policy.acceso_total?
+    #     scope.all
+    #   else
+    #     scope.none
+    #   end
+    # end
+  end
+
+  # def puede_editar?
+  #   acceso_total? && !record.readonly?
+  # end
+
+  # def puede_crear?
+  #   acceso_total? || user.asesor?
+  # end
+
+  # def puede_borrar?
+  #   acceso_total? && !record.readonly?
+  # end
+
+  # def acceso_total?
+  #   user.admin?
+  # end
+end
+<% end -%>

data/lib/generators/pg_rails/instalar/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate instalar Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/pg_rails/instalar/instalar_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module PgRails
+  class InstalarGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def copy_application_policy
+      template 'pg_rails.rb', 'config/initializers/pg_rails.rb'
+    end
+
+    private
+
+      def clase_aplicacion
+        'cosa'
+      end
+  end
+end

data/lib/generators/pg_rails/instalar/templates/pg_rails.rb

@@ -0,0 +1,10 @@
+<%= clase_aplicacion %>.configure do
+  config.generators do |g|
+    g.fixture_replacement :pg_factory_bot, dir: 'spec/factories'
+    g.test_framework :pg_rspec
+    g.orm :pg_active_record
+
+    g.fallbacks[:pg_rspec] = :rspec
+    g.fallbacks[:pg_active_record] = :active_record
+  end
+end

data/lib/generators/pg_rspec/model/model_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'generators/rspec/model/model_generator'
+
+module PgRspec
+  module Generators
+    class ModelGenerator < Rspec::Generators::ModelGenerator
+      # agrego la carpeta para que busque templates
+      # manteniendo la source_root de Rspec::Generators::ScaffoldGenerator
+      # para poder copiar sólo los que quiero cambiar
+      source_paths << File.expand_path('templates', __dir__)
+
+      remove_hook_for :fixture_replacement
+
+      invoke 'pg_factory_bot:model'
+
+      def namespace # Esto quizas no es necesario
+        nil
+      end
+      def class_path # :doc:
+        []
+      end
+      def create_module_file
+      end
+    end
+  end
+end

data/lib/generators/pg_rspec/model/templates/model_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# generado con pg_rails
+
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %> do
+  let(:<%= singular_name %>) { create(:<%= singular_table_name %>) }
+
+  it 'se persiste' do
+    expect(<%= singular_name %>).to be_persisted
+  end
+end
+<% end -%>

data/lib/generators/pg_rspec/scaffold/scaffold_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'generators/rspec/scaffold/scaffold_generator'
+
+module PgRspec
+  module Generators
+    class ScaffoldGenerator < Rspec::Generators::ScaffoldGenerator
+      # agrego la carpeta para que busque templates
+      # manteniendo la source_root de Rspec::Generators::ScaffoldGenerator
+      # para poder copiar sólo los que quiero cambiar
+      source_paths << File.expand_path('templates', __dir__)
+
+      class_option :paranoia, type: :boolean, default: false, desc: 'Paranoid y deleted_at.'
+      class_option :discard, type: :boolean, default: false, desc: 'Discard y discarded_at.'
+      class_option :trackeo_de_usuarios, type: :boolean, default: true,
+                                         desc: 'Genera campos creado_por y actualizado_por.'
+
+      class_option :controller_specs, type: :boolean, default: true
+      class_option :request_specs,    type: :boolean, default: false
+      class_option :view_specs,       type: :boolean, default: false
+
+      # remove_hook_for :integration_tool, as: :integration
+      # remove_hook_for :fixture_replacement
+
+      def generate_routing_spec
+        # piso el método para que no genere nada
+      end
+
+      protected
+
+        def referencias_requeridas
+          attributes.select { |at| at.reference? && at.required? }
+        end
+
+        def merge_referencias
+          return unless referencias_requeridas.present?
+
+          asd = referencias_requeridas.map { |r| "#{r.name}_id: #{r.name}.id" }
+          ".merge(#{asd.join(', ')})"
+        end
+    end
+  end
+end