just_enum 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4407bd54833c58ac81c23c2067b06e49fe7eb055978ee9132e2f590784db3bb6
-  data.tar.gz: 6aa6c654c9303f5e3852adb86f25d45d375ff897570164cd42dc9f98c3f82485
+  metadata.gz: 5cda13c8af65bfa092be174ccfff8f703623bd4572424961ffc439573d663950
+  data.tar.gz: 42e6ca5cc0d2fa7dcd07e863f45c113513bb0facbe8fc418e2ed67b64eb89233
 SHA512:
-  metadata.gz: 169b80283833e53040ba83c4dd67061c6f377544334c5f32fd941a6327e80995a4e0e419589ccbd65aea3c28e2638f911b0df12fa3306b6cea2a9a02d28dc10e
-  data.tar.gz: 89783ddc98bce0c488b3b39966e51298c9179fed58401560fac5fc40eb5ab2934a5be7f7c3eeda6e33887f3f7262fcf86ba30408573aaa4115f90f63da5fafcf
+  metadata.gz: 230aa3583beb46aa8c2ae6e39c07f6306a3b11bb0aff1501674094beebef6bddf3798cda7e9857f1ad6c5fb210eae0f6c3ad19425e3f512f01d636524e7f767f
+  data.tar.gz: 73c066163a4afba2bba0a2d1ae28fa21087fd1436a5c6141c8ba9519acfe2e6c4257a4dead09fc606f29c212277f3dd64fdfa48c30ce169b09d29ddd06f4cccb

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 .idea
+just_enum-*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    just_enum (0.1.0)
+    just_enum (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -52,4 +52,4 @@ DEPENDENCIES
   rubocop (~> 1.7)
 
 BUNDLED WITH
-   2.2.22
+   2.2.32

data/README.md

@@ -1,8 +1,6 @@
 # JustEnum
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/just_enum`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem has been created to mimic Typescript like enums and adding additional features to the POROs.
 
 ## Installation
 
@@ -22,7 +20,235 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Defining enums
+
+After installing gem extend the class you want to make the enum for storing properties with `JustEnum::Base`.
+
+For example:
+```ruby
+class ButtonType < JustEnum::Base
+  enum %i[primary secondary]
+end
+
+class Color < JustEnum::Base
+  enum %i[success danger]
+end
+
+class Labels < JustEnum::Base
+  enum({save: "Zapisz", cancel: "Anuluj"})
+end
+```
+
+So that you can have enum classes as Ruby singletons. You can use:
+```ruby
+ButtonType.primary #=> 0
+ButtonType.secondary #=> 1
+Color.success #=> 0
+Color.danger #=> 1
+Labels.save #=> "Zapisz"
+Labels.cancel #=> "Anuluj"
+```
+
+You can list all possible options in the enum by using `.options` static method
+```ruby
+ButtonType.options #=> [:primary, :secondary]
+Color.options #=> {:success=>"success", :danger=>"danger"}
+Labels.options #=> {:save=>"Zapisz", :cancel=>"Anuluj"}
+```
+
+### How enums are defined in JustEnum
+#### Indexed enum
+```ruby
+class ButtonType < JustEnum::Base
+  enum %i[primary secondary]
+end
+```
+
+```ruby
+enum %i[primary secondary]
+
+# is the same as:
+
+{ primary: 0, secondary: 1 }
+```
+
+#### Enum with custom values
+You can define custom values for enums
+
+```ruby
+class Labels < JustEnum::Enum
+  enum({ save: "Zapisz", cancel: "Anuluj" })
+end
+```
+
+```ruby
+enum({ save: "Zapisz", cancel: "Anuluj" })
+
+# is the same as:
+
+{ save: "Zapisz", cancel: "Anuluj" }
+```
+
+#### Mirrored enum keys
+You can mirror your keys as the values in enum.
+
+```ruby
+class Color < JustEnum::Base
+  enum %i[success danger], mirror: true
+end
+```
+
+```ruby
+enum %i[success danger], mirror: true
+
+# is the same as:
+
+{ success: "success", danger: "danger" }
+```
+
+### Use defined enums as values in your PORO classes.
+
+Than You can use the enum to define values for fields in your PORO classes. Do it by extending your 
+class with `JustEnum::Enum`
+
+```ruby
+class ButtonPrimary
+  extend JustEnum::Enum
+  enumerate :type, ButtonType, ButtonType.primary
+  enumerate :color, Color, Color.success
+  enumerate :label, Labels, Labels.save
+end
+```
+
+You can also omit the `extend` directive and use it in traditional way in constructor or `attr_writer`.
+
+```ruby
+class ButtonPrimary
+  def initialize(type, color, label)
+    @type = ButtonType.primary
+    @color = Color.success
+    @label = Labels.save
+  end
+end
+```
+
+### Extend your class with `JustEnum::Enum`
+When extending your PORO with `JustEnum::Enum`:
+
+a) you can access the `enumarate` method which defines instance fields with values provided by enums
+```ruby
+class ButtonPrimary
+  extend JustEnum::Enum
+  enumerate :type, ButtonType, ButtonType.primary
+  enumerate :color, Color, Color.success
+  enumerate :label, Labels, Labels.save
+end
+```
+
+b) you have public underscored accessors for defined fields which will return the Enum definition as
+complex type
+
+```ruby
+button = ButtonPrimary.new
+
+button._type #=> ButtonType.primary
+button._color #=> Color.success
+button._label #=> Labels.save
+```
+
+c) you have the string representation of defined enumerated fields with `str_` prefix
+
+```ruby
+button = ButtonPrimary.new
+
+button.str_type #=> 'primary'
+button.str_color #=> 'success'
+button.str_label #=> 'Zapisz'
+```
+
+d) you have boolean methods allowing to check which enum value has been defined or in other words:
+of what enum is the field in your PORO class
+
+```ruby
+button = ButtonPrimary.new
+
+button.button_type_primary? #=> true
+button.button_type_secondary? #=> false
+button.color_success? #=> true
+button.color_danger? #=> false
+button.label_save? #=> true
+button.label_cancel? #=> false
+```
+
+### Usage with ViewComponent
+It's very convenient to use JustEnum with [ViewComponent gem from Github](https://github.com/github/view_component)
+You can define your enum classes:
+```ruby
+module Enums
+  class ButtonType < JustEnum::Base
+    enum %i[primary secondary default success]
+  end
+end
+```
+
+Then extend your component classes with `JustEnum::Enum`
+```ruby
+# frozen_string_literal: true
+
+class ButtonPrimary < ViewComponent::Base
+  extend JustEnum::Enum
+  enumerate :type, ButtonType, ButtonType.primary
+  
+  attr_reader :label
+  
+  def initialize(label:)
+    @label = label
+  end
+end
+
+<%= render ButtonPrimary.new(label: "Start search") %>
+```
+
+Or you can go one step further and encapsulate enums in static methods
+
+```ruby
+# frozen_string_literal: true
+
+class Button < ViewComponent::Base
+  include Enums::ButtonType::Enum
+
+  class << self
+    def primary(**args)
+      args[:type_class] = %w[border-transparent text-white bg-indigo-600 hover:bg-indigo-700]
+      new(**args, type: Enums::ButtonType.primary)
+    end
+
+    def secondary(**args)
+      new(**args, type: Enums::ButtonType.secondary)
+    end
+
+    def default(**args)
+      args[:type_class] = %w[bg-white border-gray-300 text-gray-700 hover:bg-gray-5]
+      new(**args, type: Enums::ButtonType.default)
+    end
+
+    def success(**args)
+      new(**args, type: Enums::ButtonType.success)
+    end
+  end
+
+  attr_reader :label,
+
+  def initialize(label:, type:)
+    @type = args[:type] || Enums::ButtonType.default
+    @label = args[:label]
+  end
+end
+
+<%= render Button.default(label: "Cancel") %>
+<%= render Button.primary(label: "Start search") %>
+
+```
 
 ## Development
 
@@ -32,4 +258,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/just_enum.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rafpiek/just_enum.

data/just_enum.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Simple enum module extending Ruby with TypeScript like enums"
   spec.description   = "Module extends PORO classes in enums and generate helpers for other POROS using those enums"
-  spec.homepage      = "https://grubykodzi.pl"
+  spec.homepage      = "https://github.com/rafpiek/just_enum"
   spec.required_ruby_version = ">= 2.4.0"
 
 

data/lib/just_enum/base.rb

@@ -7,6 +7,7 @@ module JustEnum
             hash[i] = i.to_s
           end
         end
+        define_singleton_method(:mirrored?) { mirror }
         define_singleton_method(:options) { options }
         case options
         when Array

data/lib/just_enum/enum.rb

@@ -3,7 +3,11 @@ module JustEnum::Enum
   def enumerate(field_key, enum_class, field_value)
     has_hash_options = enum_class.options.is_a? Hash
     if has_hash_options
-      define_method("str_#{field_key.to_s}") { enum_class.options[field_value.to_sym] }
+      if enum_class.mirrored?
+        define_method("str_#{field_key.to_s}") { enum_class.options[field_value.to_sym] }
+      else
+        define_method("str_#{field_key.to_s}") { enum_class.options.find { |k, v| v.to_s == field_value.to_s }[1] }
+      end
       enum_class.options.each_pair do |key, value|
         define_method("#{enum_class.name.snakecase}_#{key.to_s}?") { field_value == value }
       end

data/lib/just_enum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JustEnum
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rafal Piekara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies: []
 description: Module extends PORO classes in enums and generate helpers for other POROS
   using those enums
@@ -33,10 +33,10 @@ files:
 - lib/just_enum/enum.rb
 - lib/just_enum/string.rb
 - lib/just_enum/version.rb
-homepage: https://grubykodzi.pl
+homepage: https://github.com/rafpiek/just_enum
 licenses: []
 metadata:
-  homepage_uri: https://grubykodzi.pl
+  homepage_uri: https://github.com/rafpiek/just_enum
   source_code_uri: https://github.com/rafpiek/just_enum
   changelog_uri: https://github.com/rafpiek/just_enum
 post_install_message: