literal_enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4da670aa086260311dedd8f84f66850b957cd442b66a41ffb4cb2f81f63abf2e
+  data.tar.gz: 45c944babb48f43b0d7baafffd349da06989f9f369a1a46467d049088a48cfd0
+SHA512:
+  metadata.gz: c66cef636f7d009620f57684135a872789896d8261b2a908fda73480e42b55ba3d4b3b3d5e3cd4aeed1789b542e98fba0e040ba573422d7b738901450d5f8124
+  data.tar.gz: 5074c13457bb6e00b31e0a409135bd9d235a55864af5b7e6d5902763de0d695845b8322e2b497592005becc1230aaecafbc7c3e9fdc18c772b1588720dfb66fb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright letItCurl
+
+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,48 @@
+# LiteralEnum
+Stop using integers in your database when using enums. Use the enum type define in your model for better DX.
+
+## Usage
+
+The following `class_method` is added to your arsenal and now `["pending", "accepted"]` are saved as strings in your database.
+
+```ruby
+class Article < ApplicationRecord
+  # @NOTE:
+  # The column `status` is supposed to be of type string in your database.
+  literal_enum :status, ["pending", "accepted"]
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "literal_enum"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install literal_enum
+```
+
+## Contributing
+Open a PR ;)
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Special thanks:
+
+Huge shout-out to [hundredwatt](https://github.com/hundredwatt)!
+
+I was tired of this integer in the database when using enums, and he jumped into the discussion on Twitter and showed me this:
+- [https://gist.github.com/hundredwatt/9742581230a320eaac008ef01e90f156](https://gist.github.com/hundredwatt/9742581230a320eaac008ef01e90f156)
+
+After learning about Rails engines, I thought that this could be a great first gem ;)
+
+The original `class_method` is actually from the gist by [@hundredwatt](https://gist.github.com/hundredwatt/9742581230a320eaac008ef01e90f156).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/literal_enum_manifest.js

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

data/app/assets/stylesheets/literal_enum/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/literal_enum/application_controller.rb

@@ -0,0 +1,4 @@
+module LiteralEnum
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/literal_enum/application_helper.rb

@@ -0,0 +1,4 @@
+module LiteralEnum
+  module ApplicationHelper
+  end
+end

data/app/jobs/literal_enum/application_job.rb

@@ -0,0 +1,4 @@
+module LiteralEnum
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/literal_enum/application_mailer.rb

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

data/app/models/concerns/literal_enum/binder.rb

@@ -0,0 +1,13 @@
+module LiteralEnum::Binder
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def literal_enum(name = nil, values = nil, **options)
+      if values.is_a?(Array)
+        values = values.map { |value| [value] * 2 }.to_h
+      end
+
+      enum(name, values, **options)
+    end
+  end
+end

data/app/models/literal_enum/application_record.rb

@@ -0,0 +1,5 @@
+module LiteralEnum
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/literal_enum/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Literal enum</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "literal_enum/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

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

data/lib/literal_enum/engine.rb

@@ -0,0 +1,11 @@
+module LiteralEnum
+  class Engine < ::Rails::Engine
+    isolate_namespace LiteralEnum
+
+    initializer "literal_enum.active_record" do
+      ActiveSupport.on_load :active_record do
+        include LiteralEnum::Binder
+      end
+    end
+  end
+end

data/lib/literal_enum/version.rb

@@ -0,0 +1,3 @@
+module LiteralEnum
+  VERSION = "0.1.0"
+end

data/lib/literal_enum.rb

@@ -0,0 +1,6 @@
+require "literal_enum/version"
+require "literal_enum/engine"
+
+module LiteralEnum
+  # Your code goes here...
+end

data/lib/tasks/literal_enum_tasks.rake

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

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: literal_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- letItCurl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+description:
+email:
+- rolandlopez.developer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/literal_enum_manifest.js
+- app/assets/stylesheets/literal_enum/application.css
+- app/controllers/literal_enum/application_controller.rb
+- app/helpers/literal_enum/application_helper.rb
+- app/jobs/literal_enum/application_job.rb
+- app/mailers/literal_enum/application_mailer.rb
+- app/models/concerns/literal_enum/binder.rb
+- app/models/literal_enum/application_record.rb
+- app/views/layouts/literal_enum/application.html.erb
+- config/routes.rb
+- lib/literal_enum.rb
+- lib/literal_enum/engine.rb
+- lib/literal_enum/version.rb
+- lib/tasks/literal_enum_tasks.rake
+homepage:
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key:
+specification_version: 4
+summary: Stop using integers in your database when using enums. Use the enum type
+  define in your model for better DX.
+test_files: []