abizvn-general 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 343c8e74ec686c034435fd2f1fd1dcc6d07e4c589b6484faad357694ba7caf7b
+  data.tar.gz: 6b10a3372d6492509728c6fde0633268e85b0844c3cb52e211127392db0366b7
+SHA512:
+  metadata.gz: 81f74e9e1749a91effda58be635d7e34151d34a71fff05238fd3884435ce6207aee1eb4a3cf40f55850ac3ee46b9186adc59c19f591807ef9abdb2bd4a401235
+  data.tar.gz: '07148d2bb6892e37348bcb5e5b976248e5b0efdeae9904abbfd9eeb3a1acd4e267dda785862fd367c688d28187fa7cffc1dc4c93a4d6b9df2c1919d6946f738d'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Juan
+
+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 @@
+# Abizvn::General
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "abizvn-general"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install abizvn-general
+```
+
+## 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,5 @@
+require "bundler/setup"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/admin/general_settings.rb

@@ -0,0 +1,20 @@
+ActiveAdmin.register Abizvn::General::GeneralSetting, as: 'general_setting' do
+  menu label: 'General Settings', parent: "System", priority: 2
+
+  permit_params do
+    permitted = [:code, :value, :active, :order]
+    permitted << :group if params[:action] == 'create'
+    permitted
+  end
+
+  form do |f|
+    f.inputs do
+      f.input :group if params[:action] == 'new'
+      f.input :code
+      f.input :value
+      f.input :order
+      f.input :active
+    end
+    f.actions
+  end
+end

data/app/assets/config/abizvn_general_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/abizvn/general .css

data/app/assets/stylesheets/abizvn/general/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/abizvn/general/application_controller.rb

@@ -0,0 +1,6 @@
+module Abizvn
+  module General
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/helpers/abizvn/general/application_helper.rb

@@ -0,0 +1,6 @@
+module Abizvn
+  module General
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/abizvn/general/application_job.rb

@@ -0,0 +1,6 @@
+module Abizvn
+  module General
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/abizvn/general/application_mailer.rb

@@ -0,0 +1,8 @@
+module Abizvn
+  module General
+    class ApplicationMailer < ActionMailer::Base
+      default from: "from@example.com"
+      layout "mailer"
+    end
+  end
+end

data/app/models/abizvn/general/general_setting.rb

@@ -0,0 +1,14 @@
+module Abizvn
+  module General
+    class GeneralSetting < Commonbase::ApplicationRecord
+      include Commonbase::RansackSearchable
+    
+      self.table_name = 'general_settings'
+    
+      validates :order, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
+    
+      scope :ordered, -> { order(group: :asc, order: :asc) }
+      scope :activated, -> { where(active: :true) }
+    end
+  end
+end

data/app/views/layouts/abizvn/general/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Abizvn general</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "abizvn/general/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Abizvn::General::Engine.routes.draw do
+end

data/db/migrate/20241115080211_create_general_settings.rb

@@ -0,0 +1,11 @@
+class CreateGeneralSettings < ActiveRecord::Migration[7.2]
+  def change
+    create_table :general_settings do |t|
+      t.string :group
+      t.string :code
+      t.string :value
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20241116110614_add_index_into_general_settings.rb

@@ -0,0 +1,5 @@
+class AddIndexIntoGeneralSettings < ActiveRecord::Migration[7.2]
+  def change
+    add_index :general_settings, [:group, :code], unique: true, name: 'index_general_settings_group_and_code'
+  end
+end

data/db/migrate/20250104054920_review_general_setting.rb

@@ -0,0 +1,6 @@
+class ReviewGeneralSetting < ActiveRecord::Migration[7.2]
+  def change
+    add_column :general_settings, :order, :integer, null: false, default: 0
+    add_column :general_settings, :active, :boolean, null: false, default: true
+  end
+end

data/db/migrate/20250218110737_create_entity_status_collection.rb

@@ -0,0 +1,27 @@
+class CreateEntityStatusCollection < ActiveRecord::Migration[7.2]
+  def up
+    Abizvn::General::GeneralSetting.find_or_create_by!(group: Abizvn::General::ENTITY_STATUS_GROUP_NAME, code: Abizvn::General::ENTITY_STATUS_CODE_DRAFT) do |entity|
+      entity.value = 'Draft'
+    end
+    Abizvn::General::GeneralSetting.find_or_create_by!(group: Abizvn::General::ENTITY_STATUS_GROUP_NAME, code: Abizvn::General::ENTITY_STATUS_CODE_PUBLIC) do |entity|
+      entity.value = 'Public'
+    end
+    Abizvn::General::GeneralSetting.find_or_create_by!(group: Abizvn::General::ENTITY_STATUS_GROUP_NAME, code: Abizvn::General::ENTITY_STATUS_CODE_INVISIBLE) do |entity|
+      entity.value = 'Unlist'
+    end
+    Abizvn::General::GeneralSetting.find_or_create_by!(group: Abizvn::General::ENTITY_STATUS_GROUP_NAME, code: Abizvn::General::ENTITY_STATUS_CODE_PRIVATE) do |entity|
+      entity.value = 'Private'
+    end
+  end
+
+  def down
+    list_codes = [
+      Abizvn::General::ENTITY_STATUS_CODE_DRAFT,
+      Abizvn::General::ENTITY_STATUS_CODE_PUBLIC,
+      Abizvn::General::ENTITY_STATUS_CODE_INVISIBLE,
+      Abizvn::General::ENTITY_STATUS_CODE_PRIVATE
+    ]
+
+    Abizvn::General::GeneralSetting.where(group: Abizvn::General::ENTITY_STATUS_GROUP_NAME, code: list_codes).destroy_all    
+  end
+end

data/lib/abizvn/general/engine.rb

@@ -0,0 +1,7 @@
+module Abizvn
+  module General
+    class Engine < ::Rails::Engine
+      isolate_namespace Abizvn::General
+    end
+  end
+end

data/lib/abizvn/general/version.rb

@@ -0,0 +1,5 @@
+module Abizvn
+  module General
+    VERSION = "0.1.1"
+  end
+end

data/lib/abizvn/general.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require "abizvn/general/version"
+require "abizvn/general/engine"
+require "commonbase"  # To load the common base gem
+
+module Abizvn
+  module General
+    ENTITY_STATUS_GROUP_NAME = 'entity_status'
+
+    ENTITY_STATUS_CODE_DRAFT = 'draft'
+    ENTITY_STATUS_CODE_PUBLIC = 'public'
+    ENTITY_STATUS_CODE_INVISIBLE = 'invisible'
+    ENTITY_STATUS_CODE_PRIVATE = 'private'
+
+    def self.entity_status_collection
+      return get_collection_by_group(ENTITY_STATUS_GROUP_NAME)
+    end
+
+    def self.get_collection_by_group(group)
+      return Abizvn::General::GeneralSetting.where(group: group).activated.ordered.pluck(:value, :id)
+    end
+  end
+end

data/lib/tasks/abizvn/general_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :abizvn_general do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: abizvn-general
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Juan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: commonbase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: Managing General Settings for an application.
+email:
+- juanonsoftware@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/admin/general_settings.rb
+- app/assets/config/abizvn_general_manifest.js
+- app/assets/stylesheets/abizvn/general/application.css
+- app/controllers/abizvn/general/application_controller.rb
+- app/helpers/abizvn/general/application_helper.rb
+- app/jobs/abizvn/general/application_job.rb
+- app/mailers/abizvn/general/application_mailer.rb
+- app/models/abizvn/general/general_setting.rb
+- app/views/layouts/abizvn/general/application.html.erb
+- config/routes.rb
+- db/migrate/20241115080211_create_general_settings.rb
+- db/migrate/20241116110614_add_index_into_general_settings.rb
+- db/migrate/20250104054920_review_general_setting.rb
+- db/migrate/20250218110737_create_entity_status_collection.rb
+- lib/abizvn/general.rb
+- lib/abizvn/general/engine.rb
+- lib/abizvn/general/version.rb
+- lib/tasks/abizvn/general_tasks.rake
+homepage: https://abizvn.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://abizvn.com
+  source_code_uri: https://github.com/abizvncom/abizvn-general
+  changelog_uri: https://github.com/abizvncom/abizvn-general
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: General Settings for an application.
+test_files: []