commento 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2558be497fdf71eca0c553371dc0fb09fdb348a04bc930289ad3696a571a4fa
+  data.tar.gz: c4e41098d7c6ffcff077d5c18545e7c0d03fcb33b3b1273bb4cfac0406cabf38
+SHA512:
+  metadata.gz: f93c37134940512adbe7fd03600d7aeb0f4af032b9196c55bc5d011a310138c5f2fbefc4b8962abd9aa7cbc88ab41156cff8121eb80142df91e057146c60f779
+  data.tar.gz: c66a4d0f5e6a626982a3842d743b712fe7023fd3303369426a9f911d4b4c3fbb7ebd00712b02de70f192857b4aa5adb0573bf7a782f4aa054ce3946c90e33da6

data/README.md

@@ -0,0 +1,64 @@
+# Commento
+
+Commento provides DSL for Ruby on Rails application for working with database comments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'commento'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## Gem configuration
+
+### Initializer
+
+Add configuration line to config/initializers/commento.rb:
+
+#### ActiveRecord
+
+```ruby
+require 'commento/adapters/active_record'
+
+Commento.configure do |config|
+  config.adapter = Commento::Adapters::ActiveRecord.new
+end
+```
+
+### Models
+
+Update you application model
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include Commento::Helpers
+end
+```
+
+## Usage
+
+Commento provides helpers for models for setting and getting table's column comments.
+
+### Set table's column comment
+
+```ruby
+User.set_column_comment(:email, 'Required field for user authentication')
+```
+
+or reset comment by skiping value
+```ruby
+User.set_column_comment(:email)
+```
+
+### Read table's column comment
+
+```ruby
+User.get_column_comment(:email)
+```
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/commento/adapters/active_record.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module Commento
+  module Adapters
+    class ActiveRecord
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Public: Initialize a new ActiveRecord adapter instance.
+      #
+      # name - The Symbol name for this adapter. Optional (default :active_record)
+      def initialize(options={})
+        @name = options.fetch(:name, :active_record)
+      end
+
+      # Public: Sets comment for table's column.
+      def set_column_comment(table_name, column_name, value)
+        sql = "COMMENT ON COLUMN #{table_name}.#{column_name} IS "
+        sql += value ? "'#{value}'" : 'NULL'
+        execute(sql)
+      end
+
+      # Public: Returns comment for table's column.
+      def get_column_comment(table_name, column_name)
+        sql = <<-SQL.squish
+          SELECT
+            cols.column_name,
+            pg_catalog.col_description(c.oid, cols.ordinal_position::int)
+          FROM pg_catalog.pg_class c, information_schema.columns cols
+          WHERE
+            cols.table_catalog = '#{Rails.configuration.database_configuration[Rails.env]["database"]}' AND
+            cols.table_schema = 'public' AND
+            cols.table_name = '#{table_name}' AND
+            cols.table_name = c.relname
+        SQL
+        column_data = execute(sql).to_a.find { |column| column['column_name'].to_sym == column_name }
+        column_data.presence ? column_data['col_description'] : nil
+      end
+
+      private
+
+      def execute(sql)
+        ::ActiveRecord::Base.connection.execute(sql)
+      end
+    end
+  end
+end

data/lib/commento/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Commento
+  class Configuration
+    attr_accessor :adapter
+
+    def initialize
+      @adapter = nil
+    end
+  end
+end

data/lib/commento/dsl.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Commento
+  class DSL
+    attr_reader :adapter
+
+    # Public: Returns a new instance of the DSL.
+    #
+    # adapter - The adapter that this DSL instance should use.
+    def initialize(adapter)
+      @adapter = adapter
+    end
+
+    # Public: Sets comment for table's column.
+    def set_column_comment(table_name, column_name, value)
+      adapter.set_column_comment(table_name, column_name, value)
+    end
+
+    # Public: Returns comment for table's column.
+    def get_column_comment(table_name, column_name)
+      adapter.get_column_comment(table_name, column_name)
+    end
+  end
+end

data/lib/commento/helpers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Commento
+  module Helpers
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def set_column_comment(column_name, value=nil)
+        instance.set_column_comment(table_name, column_name, value)
+      end
+
+      def get_column_comment(column_name)
+        instance.get_column_comment(table_name, column_name)
+      end
+
+      def instance
+        Commento.instance
+      end
+    end
+  end
+end

data/lib/commento/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Commento
+  VERSION = '0.1.0'
+end

data/lib/commento.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require 'commento/version'
+require 'commento/configuration'
+require 'commento/dsl'
+require 'commento/helpers'
+
+module Commento
+  extend self
+  extend Forwardable
+
+  # Public: Given an adapter returns a handy DSL to all the commentp goodness.
+  def new(adapter)
+    DSL.new(adapter)
+  end
+
+  # Public: Configure commentp.
+  #
+  #   Commento.configure do |config|
+  #     config.adapter = Commento::Adapters::ActiveRecord.new
+  #   end
+  #
+  def configure
+    yield configuration
+  end
+
+  # Public: Returns Commento::Configuration instance.
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Public: Default per thread commentp instance if configured.
+  # Returns Commento::DSL instance.
+  def instance
+    Thread.current[:commento_instance] ||= new(configuration.adapter)
+  end
+
+  # Public: All the methods delegated to instance. These should match the interface of Commento::DSL.
+  def_delegators :instance, :adapter
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: commento
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bogdanov Anton
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Commento allows to work with database comments.
+email:
+- kortirso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/commento.rb
+- lib/commento/adapters/active_record.rb
+- lib/commento/configuration.rb
+- lib/commento/dsl.rb
+- lib/commento/helpers.rb
+- lib/commento/version.rb
+homepage: https://github.com/kortirso/commento
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kortirso/commento
+  source_code_uri: https://github.com/kortirso/commento
+  changelog_uri: https://github.com/kortirso/commento/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Work with database comments.
+test_files: []