schemattr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d2d2b02fcfc5238afd51f0741a619f334315e785b91c2add642cc1ef0955962
-  data.tar.gz: b586cd63d36d773027f6786b81c785eba67b4439a1f9999140e7bff4ad44eb4d
+  metadata.gz: 1ed48f215b1651cfcaca945564ee28889209196633128c453c25050c93948092
+  data.tar.gz: 1d93e1999e211d8168b2f1dea9bb650043afe606a0c6c2eeb006689a6f4184eb
 SHA512:
-  metadata.gz: 6bd7afaa4e360c1efe3b171fe2815f2687c23aaf6f1243bdb162ad720788ffd531b2569bfc63e16cd35698a0ad52fdc80196518703651c02d4e7251fe985a59c
-  data.tar.gz: a59b2bd4c1f0bc29ba27d0859512fd863208f4b7591d4a951e67b60e2f80c4a6053fbd61b0598ef264798249ae84c3df4d51591ff9c18f24cc88ec23daee7bb3
+  metadata.gz: e38303d1c00e993a70b4f64dd37287aef23b3eac18a4a233482adc01e9ed90714a71b50128208eb8f46ec26d2e0c5e7c965470cf9e4cbd7b328a663ca0492f6e
+  data.tar.gz: 43361ee53cabc37ca4f3e538cf93d1fb4328584e4564e0230cb7a352a375d59895c7ca9503fa71e3287638490780bc7cd0b80de1fd56a40ffbfc0f2a311fd302

data/{MIT.LICENSE → MIT-LICENSE}

@@ -1,6 +1,4 @@
-Copyright 2019 Jeremy Jackson
-
-https://github.com/jejacks0n/schemattr
+Copyright 2023 Jeremy Jackson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,16 +1,19 @@
-Schemattr
-=========
+# Schemattr - Schema-ish ActiveRecord attributes 
 
-[![Gem Version](https://img.shields.io/gem/v/schemattr.svg)](http://badge.fury.io/rb/schemattr)
-[![Build Status](https://img.shields.io/travis/jejacks0n/schemattr.svg)](https://travis-ci.org/jejacks0n/schemattr)
-[![Code Climate](https://codeclimate.com/github/jejacks0n/schemattr/badges/gpa.svg)](https://codeclimate.com/github/jejacks0n/schemattr)
-[![Test Coverage](https://codeclimate.com/github/jejacks0n/schemattr/badges/coverage.svg)](https://codeclimate.com/github/jejacks0n/schemattr)
-[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
+<img alt="Shemattr" width="150" height="144" src="https://user-images.githubusercontent.com/13765/255353418-61285561-09cf-4208-8dd5-c00455e4288a.png" align="right" hspace="20">
+
+[![Gem Version](https://img.shields.io/gem/v/schemattr.svg?label=gem%20version)](https://rubygems.org/gems/schemattr)
+[![MIT License](https://img.shields.io/github/license/jejacks0n/schemattr.svg)](https://opensource.org/licenses/MIT)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/jejacks0n/schemattr/ci.yml.svg?label=build%20status)](https://github.com/jejacks0n/schemattr/actions/workflows/ci.yml)
+[![Maintainability](https://img.shields.io/codeclimate/coverage-letter/jejacks0n/schemattr.svg?label=maintainability)](https://codeclimate.com/github/jejacks0n/schemattr/maintainability)
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/jejacks0n/schemattr.svg?label=test%20coverage)](https://codeclimate.com/github/jejacks0n/schemattr/test_coverage)
+[![RubyGems](https://img.shields.io/gem/dt/schemattr.svg?label=rubygems%20downloads)](https://rubygems.org/gems/schemattr)
 
 Schemattr is an ActiveRecord extension that provides a helpful schema-less attribute DSL. It can be used to define a
 simple schema for a single attribute that can change over time without having to migrate existing data.
 
 ### Background
+
 Let's say you have a User model, and that model has a simple concept of settings -- just one for now. It's a boolean
 named `opted_in`, and it means that the user is opted in to receive email updates. Sweet, we go add a migration for this
 setting and migrate. Ship it, we're done with that feature.
@@ -32,19 +35,33 @@ methods, can keep a real column synced with one if its fields, and more.
 If you're using Schemattr and want to add a new setting field, it's as simple as adding a new field to the attribute
 schema and setting a default right there in the code. No migrations, no hassles, easy deployment.
 
-## Installation
+## Download and Installation
+
+Add this line to your Gemfile:
+
 ```ruby
 gem "schemattr"
 ```
 
+Or install the latest version with RubyGems:
+
+```bash
+gem install schemattr
+```
+
+Source code can be downloaded as part of the project on GitHub:
+
+* https://github.com/jejacks0n/schemattr
+
 ## Usage
+
 In the examples we assume there's already a User model and table.
 
 First, let's create a migration to add your schema-less attribute. In postgres you can use a JSON column. We use the
 postgres JSON type as our example because the JSON type allows queries and indexing, and hstore does annoying things to
 booleans. We don't need to set our default value to an empty object because Schemattr handles that for us.
 
-*Note*: If you're using a different database provider, like sqlite3 for instance, you can use a text column and tell
+_Note_: If you're using a different database provider, like sqlite3 for instance, you can use a text column and tell
 ActiveRecord to serialize that column (e.g. `serialize :settings` in your model). Though, you won't be able to easily
 query in these cases so consider your options.
 
@@ -75,8 +92,8 @@ Notice that we've done nothing else, but we already have a working version of wh
 ```
 user = User.new
 user.settings.opted_in? # => true
-user.settings.email_group_advanced? # => false 
-user.settings.email_group_expert? # => false 
+user.settings.email_group_advanced? # => false
+user.settings.email_group_expert? # => false
 ```
 
 If we save the user at this point, these settings will be persisted. We can also make changes to them at this point, and
@@ -84,27 +101,30 @@ when they're persisted they'll include whatever we've changed them to be. If we
 they'll just be the defaults if we ever ask again.
 
 ### Field types
+
 The various field types are outlined below. When you define a string field for instance, the value will be coerced into
 a string at the time that it's set.
 
-type     | description
----------|--------------
-boolean  | boolean value
-string   | string value  
-text     | same as string type
-integer  | number value
-bigint   | same as integer
-float    | floating point number value
-decimal  | same as float
-datetime | datetime object
-time     | time object (stored the same as datetime)
-date     | date object
+| type     | description                               |
+|----------|-------------------------------------------|
+| boolean  | boolean value                             |
+| string   | string value                              |
+| text     | same as string type                       |
+| integer  | number value                              |
+| bigint   | same as integer                           |
+| float    | floating point number value               |
+| decimal  | same as float                             |
+| datetime | datetime object                           |
+| time     | time object (stored the same as datetime) |
+| date     | date object                               |
+| hash     | hash object                               |
 
 You can additionally define your own types using `field :foo, :custom_type` and there will no coercion at the time the
 field is set -- this is intended for when you need something that doesn't care what type it is. This generally makes it
 harder to use in forms however.
 
 ### Delegating
+
 If you don't like the idea of having to access these attributes at `user.settings` you can specify that you'd like them
 delegated. This adds delegation of the methods that exist on settings to the User instances.
 
@@ -122,10 +142,11 @@ user.opted_in? # => false
 ```
 
 ### Strict mode vs. arbitrary fields
+
 By default, Schemattr doesn't allow arbitrary fields to be added, but it supports it. When strict mode is disabled, it
 allows any arbitrary field to be set or asked for.
 
-*Note*: When delegated and strict mode is disabled, you cannot set arbitrary fields on the model directly and must
+_Note_: When delegated and strict mode is disabled, you cannot set arbitrary fields on the model directly and must
 access them through the attribute that you've defined -- in our case, it's `settings`.
 
 ```ruby
@@ -143,6 +164,7 @@ user.foo # => NoMethodError
 ```
 
 ### Overriding
+
 Schemattr provides the ability to specify your own attribute class. By doing so you can provide your own getters and
 setters and do more complex logic. In this example we're providing the inverse of `opted_in` with an `opted_out` psuedo
 field.
@@ -153,7 +175,7 @@ class UserSettings < Schemattr::Attribute
     !self[:opted_in]
   end
   alias_method :opted_out, :opted_out?
-  
+
   def opted_out=(val)
     self.opted_in = !val
   end
@@ -178,6 +200,7 @@ Our custom `opted_out` psuedo field won't be persisted, because it's not a defin
 existing field that is persisted (`opted_in`).
 
 #### Getters and setters
+
 When overriding the attribute class with your own, you can provide your own custom getters and setters as well. These
 will not be overridden by whatever Schemattr thinks they should do. Take this example, where when someone turns on or
 off a setting we want to subscribe/unsubscribe them to an email list via a third party.
@@ -196,9 +219,10 @@ class UserSettings < Schemattr::Attribute
 end
 ```
 
-*Note*: This is not a real world scenario but serves our purposes of describing an example. 
+_Note_: This is not a real world scenario but serves our purposes of describing an example.
 
 ### Renaming fields
+
 Schemattr makes it easy to rename fields as well. Let's say you've got a field named `opted_in`, as the examples have
 shown thus far. But you've added new email lists, and you think `opted_in` is too vague. Like, opted in for what?
 
@@ -207,14 +231,16 @@ We can create a new field that is correctly named, and specify what attribute we
 ```ruby
 attribute_schema :settings do
   # field :opted_in, :boolean, default: true
-  field :email_list_beginner, :boolean, from: :opted_in, default: true
+  field :email_list_beginner, :boolean, value_from: :opted_in, default: true
 end
 ```
 
-Specifying the `from: :opted_in` option will tell Schemattr to look for the value that may have already been defined in
+Specifying the `value_from: :opted_in` option will tell Schemattr to look for the value that may have already been defined in
 `opted_in` before the rename. This allows for slow migrations, but you can also write a migration to ensure this happens
 quickly.
 
+This previously used the keyword `from`, and this keyword is deprecated.
+
 ### Syncing attributes
 
 There's a down side to keeping some things internal to this settings attribute. You can query JSON types in postgres,
@@ -247,6 +273,7 @@ using things like `user.update_column(:opted_in, false)`, and `User.update_all(o
 get out of sync.
 
 ## Querying a JSON column
+
 This has come up a little bit, and so it's worth documenting -- though it has very little to do with Schemattr. When you
 have a JSON column in postgres, you can query values from within that column in various ways.
 
@@ -255,12 +282,17 @@ these are the common scenarios that we've used.
 
 ```
 User.where("(settings->>'opted_in')::boolean") # boolean query
-User.where("settings->>'string_value' = ?", "some string") # string query 
+User.where("settings->>'string_value' = ?", "some string") # string query
 ```
 
 ## License
-Licensed under the [MIT License](http://creativecommons.org/licenses/MIT/)
 
-Copyright 2019 [jejacks0n](https://github.com/jejacks0n)
+This project is released under the MIT license:
+
+* https://opensource.org/licenses/MIT
+
+Copyright 2023 [jejacks0n](https://github.com/jejacks0n)
 
 ## Make Code Not War
+
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com)

data/lib/schemattr/active_record_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Schemattr
   module ActiveRecordExtension
     module ClassMethods
@@ -38,7 +40,6 @@ module Schemattr
     end
 
     private
-
       def schemaless_attributes
         @_schemaless_attributes ||= {}
       end

data/lib/schemattr/attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Schemattr
   class Attribute
     attr_accessor :model, :attr_name, :hash
@@ -22,7 +24,6 @@ module Schemattr
     end
 
     private
-
       def method_missing(m, *args)
         if @allow_arbitrary_attributes
           self[$1] = args[0] if args.length == 1 && /^(\w+)=$/ =~ m

data/lib/schemattr/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Schemattr
   class DSL
     attr_accessor :attribute_class, :delegated, :defaults
@@ -13,8 +15,12 @@ module Schemattr
     end
 
     protected
-
       def field(name, type, options = {})
+        if options[:from].present?
+          options[:value_from] = options.delete(:from)
+          log_warning(name, type, options[:value_from])
+        end
+
         if respond_to?(type, true)
           send(type, name, options)
         else
@@ -55,10 +61,9 @@ module Schemattr
       alias_method :time, :datetime
 
     private
-
       def define(name, boolean, options, blocks = {})
         setter = blocks[:setter] || lambda { sync_value(self[name] = val, options[:sync]) }
-        getter = blocks[:getter] || lambda { migrate_value(self[name], options[:from]) }
+        getter = blocks[:getter] || lambda { migrate_value(self[name], options[:value_from]) }
         default_for(name, options[:default])
         method_for("#{name}=", options[:sync], &setter)
         method_for(name, options[:sync], &getter)
@@ -69,6 +74,14 @@ module Schemattr
         @defaults[name.to_s] = default
       end
 
+      def log_warning(name, type, old_name)
+        message = <<-HEREDOC
+          Schemattr Warning: #{name}, #{type}, from: #{old_name}
+          You are using the keyword `from:` instead of the new `value_from:`. This is deprecated and will be removed in a future version."
+        HEREDOC
+        puts message
+      end
+
       def method_for(name, delegated = false, &block)
         @delegated.push(name.to_s) if delegated
         unless attribute_class.instance_methods.include?(name.to_sym)

data/lib/schemattr/version.rb

@@ -1,3 +1,17 @@
+# frozen_string_literal: true
+
 module Schemattr
-  VERSION = "0.1.0"
+  # Returns the currently loaded version as a +Gem::Version+.
+  def self.version
+    Gem::Version.new(VERSION::STRING)
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
 end

data/lib/schemattr.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "schemattr/version"
 require "schemattr/dsl"
 require "schemattr/attribute"
-require "schemattr/active_record_extension.rb"
+require "schemattr/active_record_extension"
 
 ActiveRecord::Base.send(:include, Schemattr::ActiveRecordExtension) if defined?(ActiveRecord)

metadata

@@ -1,52 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: schemattr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- jejacks0n
-autorequire: 
+- Jeremy Jackson
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-14 00:00:00.000000000 Z
-dependencies: []
+date: 2023-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 description: Write schema-less attributes in ActiveRecord using a helpful and flexible
   DSL.
-email:
-- jejacks0n@gmail.com
+email: jejacks0n@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT.LICENSE
+- CHANGELOG.md
+- MIT-LICENSE
 - README.md
 - lib/schemattr.rb
 - lib/schemattr/active_record_extension.rb
 - lib/schemattr/attribute.rb
 - lib/schemattr/dsl.rb
 - lib/schemattr/version.rb
-homepage: http://github.com/jejacks0n/bitbot
+homepage: https://github.com/jejacks0n/schemattr
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/jejacks0n/schemattr
+  source_code_uri: https://github.com/jejacks0n/schemattr
+  bug_tracker_uri: https://github.com/jejacks0n/schemattr/issues
+  changelog_uri: https://github.com/jejacks0n/schemattr/CHANGELOG.md
+  documentation_uri: https://github.com/jejacks0n/schemattr/README.md
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.4.14
+signing_key:
 specification_version: 4
-summary: 'Schemattr: Simple schema-less column definitions for ActiveRecord'
+summary: 'Schemattr: Simple schema-less column definitions for ActiveRecord.'
 test_files: []