attribeauty 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e210c51252c3ef22e45a6c8c2d544725a9ebfd521f34ecfcc66856eae73c1c15
+  data.tar.gz: 9787f43ec2bb540e09e2704c1fad4a0cb5601f6af493bbfd824d4b99090f47b3
+SHA512:
+  metadata.gz: 0c7ebda74a3daa2cd25f5ab394a6fe464ddded6f7e2111304f63087d70a0de93e62c0630d6ae6d2a36501701109f55f475d6d5eb567646245f09c840c38529c9
+  data.tar.gz: 38ccdac185319b5999c23cfde69d971d5c294b5f0d7fccbc52394f31b1a6d8b9f432342728bd01567f339f74b0e7db2070031a25e352a12cd7490975c9d296e3

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in attribeauty.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    attribeauty (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rubocop (1.54.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  attribeauty!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Toby
+
+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,79 @@
+# Attribeauty
+
+I just wanted a quick, simple way to initialize mutable objects. This is it.
+There are so many of these, but none were what I wanted.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add attribeauty
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install attribeauty
+
+## Usage
+
+Inherit from `Attribeauty::Base` and then add attribute with the type you want.
+Initialize with these and they will be cast to that attribute.
+Use `assign_attributes` to update the object.
+
+
+```
+class MyClass < Attribeauty::Base
+  attribute :first, :string
+  attribute :second, :integer
+  attribute :third, :float
+  attribute :forth, :boolean
+  attribute :fifth, :time
+  attribute :sixth, :koala
+end
+
+instance = MyClass.new(first: 456)
+instance.first # => "456"
+instance.assign_attributes(second: "456")
+instance.second # => 456
+instance.first = 9000
+instance.first # => "9000"
+```
+
+To add your own types, simply have a class that handles `MyClassName.new.cast(value)`:
+
+```
+Attribeauty.configure do |config|
+  config.types[:koala] = MyTypes::Koala
+end
+
+module MyTypes
+  class Koala
+    def cast(value)
+      value.inspect.to_s << "_koalas"
+    end
+  end
+end
+
+class MyClass < Attribeauty::Base
+  attribute :wild_animal, :koala
+end
+
+instance = MyClass.new(wild_animal: "the_wildest_animals_are")
+instance.wild_animal # => "the_wildest_animals_are_koalas"
+
+```
+
+Note, failing to call `inspect` on the value when casting is likely to raise an error.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tobyond/attribeauty.
+
+## 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,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/attribeauty/base.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Attribeauty
+  # base class to inherit from
+  # class MyClass < Attribeauty::Base
+  class Base
+    def self.attribute(name, type)
+      @attributes ||= {}
+      return if @attributes[name]
+
+      @attributes[name] = type
+
+      class_eval(<<-CODE, __FILE__, __LINE__ + 1)
+        def #{name}=(value); @#{name} = Cast.cast(value, #{type.inspect}); end
+
+        def #{name};@#{name};end
+      CODE
+
+      return unless type == :boolean
+
+      class_eval(<<-CODE, __FILE__, __LINE__ + 1)
+        def #{name}?; !!#{name}; end
+      CODE
+    end
+
+    def initialize(**attributes)
+      attributes.each do |key, value|
+        method = "#{key}=".to_sym
+        public_send(method, value)
+      end
+    end
+
+    def assign_attributes(**attributes)
+      attributes.each do |key, value|
+        method = "#{key}=".to_sym
+        public_send(method, value)
+      end
+    end
+  end
+end

data/lib/attribeauty/cast.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "types/string"
+require_relative "types/integer"
+require_relative "types/float"
+require_relative "types/boolean"
+require_relative "types/time"
+
+module Attribeauty
+  # base cast for types
+  class Cast
+    BASE_TYPES = {
+      float: Types::Float,
+      integer: Types::Integer,
+      boolean: Types::Boolean,
+      time: Types::Time,
+      string: Types::String
+    }.freeze
+
+    def self.cast(value, type)
+      return nil if value.nil?
+
+      all_types = Attribeauty.configuration.types
+
+      raise ArgumentError, "#{type} not supported" if all_types[type].nil?
+
+      all_types[type].new.cast(value)
+    end
+  end
+end

data/lib/attribeauty/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Attribeauty
+  # Attribeauty.configure do |config|
+  #   config.types[:koala] = MyClass::Koala
+  # end
+  class Configuration
+    attr_accessor :types
+
+    def initialize
+      @types = Cast::BASE_TYPES.dup
+    end
+  end
+end

data/lib/attribeauty/types/boolean.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Attribeauty
+  module Types
+    # custom boolean type
+    class Boolean
+      FALSE_VALUES = [
+        false, 0,
+        "0", :"0",
+        "f", :f,
+        "F", :F,
+        "false", :false,
+        "FALSE", :FALSE,
+        "off", :off,
+        "OFF", :OFF
+      ].to_set.freeze
+
+      def cast(value)
+        !FALSE_VALUES.include?(value)
+      end
+    end
+  end
+end

data/lib/attribeauty/types/float.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Attribeauty
+  module Types
+    # custom float type
+    class Float
+      def cast(value)
+        Float(value)
+      end
+    end
+  end
+end

data/lib/attribeauty/types/integer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Attribeauty
+  module Types
+    # custom integer type
+    class Integer
+      def cast(value)
+        Integer(value)
+      end
+    end
+  end
+end

data/lib/attribeauty/types/string.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Attribeauty
+  module Types
+    # custom string type
+    class String
+      def cast(value)
+        String(value)
+      end
+    end
+  end
+end

data/lib/attribeauty/types/time.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Attribeauty
+  module Types
+    # custom Time type
+    class Time
+      def cast(value)
+        case value
+        when Time
+          value
+        when Date, DateTime
+          value.to_time
+        when Integer
+          ::Time.at(value / 1000.0)
+        when Numeric
+          ::Time.at(value)
+        else
+          ::Time.parse(value)
+        end
+      end
+    end
+  end
+end

data/lib/attribeauty/version.rb

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

data/lib/attribeauty.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "attribeauty/version"
+require_relative "attribeauty/base"
+require_relative "attribeauty/cast"
+require_relative "attribeauty/configuration"
+require "date"
+require "time"
+
+# Module
+module Attribeauty
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/sig/attribeauty.rbs

@@ -0,0 +1,4 @@
+module Attribeauty
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: attribeauty
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toby
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-09 00:00:00.000000000 Z
+dependencies: []
+description: There are so many of these, I just needed this one.
+email:
+- toby@darkroom.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/attribeauty.rb
+- lib/attribeauty/base.rb
+- lib/attribeauty/cast.rb
+- lib/attribeauty/configuration.rb
+- lib/attribeauty/types/boolean.rb
+- lib/attribeauty/types/float.rb
+- lib/attribeauty/types/integer.rb
+- lib/attribeauty/types/string.rb
+- lib/attribeauty/types/time.rb
+- lib/attribeauty/version.rb
+- sig/attribeauty.rbs
+homepage: https://github.com/tobyond/attribeauty
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tobyond/attribeauty
+  source_code_uri: https://github.com/tobyond/attribeauty
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Attributes simply done
+test_files: []