attribute_extras 0.1.4 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b20d50f3986dfb10a5e3c8d5afcb9c7b6f3acd3c4ed8ec77e7f2f0bdd4cb6b41
+  data.tar.gz: 7f05f0982053f65ed2bc96993a2e50d99c7f53257e8d941e5a5adae735cd90dc
+SHA512:
+  metadata.gz: 52c7e755eab89794cb6e8fd424ad390534a02c26fd4082a896fe93c42f6c0b107b2f493b253b09d29df0bcb71c7ab5afa4cdf7c44cc12129928322b11e586d53
+  data.tar.gz: c17ab44ea5736d792e6288f14d9bf014ec32889fabbdefee0b503ff9e29ce1f7cd0dba95cfa452f397ff3014056687a540388163e913b725c7a0c842e5f6b115

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/main.yml

@@ -0,0 +1,35 @@
+name: Main
+on:
+- push
+- pull_request_target
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+    - run: sudo apt-get install libsqlite3-dev
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - name: Lint and test
+      run: |
+        bundle exec rubocop --parallel
+        bundle exec rake test
+  automerge:
+    name: AutoMerge
+    needs: ci
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request_target' && (github.actor == github.repository_owner || github.actor == 'dependabot[bot]')
+    steps:
+    - uses: actions/github-script@v3
+      with:
+        script: |
+          github.pulls.merge({
+            owner: context.payload.repository.owner.login,
+            repo: context.payload.repository.name,
+            pull_number: context.payload.pull_request.number
+          })

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.7
+  Exclude:
+  - 'vendor/**/*'
+  - 'yard/**/*'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 80
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.1] - 2021-11-17
+
+### Changed
+
+- Require MFA for releasing.
+
+## [1.0.0] - 2018-12-05
+
+### Changed
+
+- Instead of overwriting the writer, adds a `before_validation` callback so that the extras can be composed.
+- From `set_*_attributes` to just `*_attributes`, .e.g, `set_nullified_attributes` became `nullify_attributes`.
+
+### Removed
+
+- All of the introspection methods.
+
+[Unreleased]: https://github.com/kddnewton/attribute_extras/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/kddnewton/attribute_extras/compare/ccda61...v1.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kddnewton@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'activerecord', '>= 6.0.0.beta1'

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    attribute_extras (1.0.1)
+      activerecord (> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.0.alpha2)
+      activesupport (= 7.0.0.alpha2)
+    activerecord (7.0.0.alpha2)
+      activemodel (= 7.0.0.alpha2)
+      activesupport (= 7.0.0.alpha2)
+    activesupport (7.0.0.alpha2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    docile (1.3.5)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 6.0.0.beta1)
+  attribute_extras!
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.12)
+  simplecov (~> 0.17)
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-present Kevin Newton
+
+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

@@ -1,105 +1,112 @@
-## AttributeExtras
+# AttributeExtras
 
-Use this gem for automatic behavior on attributes. It by default provides three class macros that can be used for managing attributes. You can also build your own macros that will automatically become available to you within your ActiveRecord models. By default each macro gets the options `:validator` and `:writer` and both are set to true. If you do not want the macros to validate or overwrite the attribute writers, you can pass false to those options.
+[![Build Status](https://github.com/kddnewton/attribute_extras/workflows/Main/badge.svg)](https://github.com/kddnewton/attribute_extras/actions)
+[![Gem](https://img.shields.io/gem/v/attribute_extras.svg)](https://rubygems.org/gems/attribute_extras)
 
-### nullify_attributes
+Use this gem for automatic behavior on attributes performed before validation. You can use the predefined extras or define your own.
 
-Causes attribute assignment to check for presence of the given value, and set the value accordingly.
+## Installation
 
-```ruby
-class Person < ActiveRecord::Base
-  nullify_attributes :name
-end
+Add this line to your application's Gemfile:
 
-p = Person.new(name: '   ')
-p.name # => nil
+```ruby
+gem 'attribute_extras'
 ```
 
-### strip_attributes
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attribute_extras
 
-Causes string attribute assignment to strip the given value, and set the value accordingly.
+## Usage
+
+`AttributeExtras` provides three extras that are predefined: `nullify_attributes`, `strip_attributes`, and `truncate_attributes`. You can use these methods to tell `AttributeExtras` to perform mutations before validation. Additionally, you can call these methods at any time to perform the mutation programmatically. Examples are below:
+
+### `ActiveRecord::Base::nullify_attributes`
+
+Sets the value to `nil` if the value is blank.
 
 ```ruby
 class Person < ActiveRecord::Base
-  strip_attributes :name
+  nullify_attributes :name
 end
 
-p = Person.new(name: '   value   ')
-p.name # => 'value'
+person = Person.create(name: '   ')
+person.name # => nil
+
+person = Person.new(name: '   ')
+person.nullify_attributes
+person.name # => nil
 ```
 
-### truncate_attributes
+### `ActiveRecord::Base::strip_attributes`
 
-Causes string attribute assignment to be truncated down to the maximum allowed value for that column.
+Strips the value.
 
 ```ruby
 class Person < ActiveRecord::Base
-  truncate_attributes :name
+  strip_attributes :name
 end
 
-p = Person.new(name: 'a' * 500)
-p.name # => 'a' * limit
-```
-
-### Inheritance
+person = Person.create(name: '   value   ')
+person.name # => 'value'
 
-By default, attributes that you manipulate with any of the above macros will be inherited into the subclasses.
-
-### Other methods
+person = Person.new(name: '   value   ')
+person.strip_attributes
+person.name # => 'value'
+```
 
-For migrating values to the correct format specified, there are two methods for each macro that will enforce the format. For example, for the `nullify_attributes` macro there is the `nullify_attributes` instance method and the `nullify_attributes!` instance method. Both will set the correct values and then call their respective `save`.
+### `ActiveRecord::Base::truncate_attributes`
 
-For introspection, there are two methods for each macro supplied. For example, for the `nullify_attributes` macro there is the `nullified_attributes` method and the `inherited_nullified_attributes` method. Examples below:
+Truncates the value to the maximum length allowed by the column.
 
 ```ruby
 class Person < ActiveRecord::Base
-  nullify_attributes :name
-end
-
-class Developer < Person
-  nullify_attributes :email
+  truncate_attributes :name
 end
 
-Person.nullified_attributes.map(&:attribute) # => [:name]
-Person.inherited_nullified_attributes.map(&:attribute) # => [:name]
+person = Person.create(name: 'a' * 500)
+person.name # => 'a' * limit
 
-Developer.nullified_attributes.map(&:attribute) # => [:email]
-Developer.inherited_nullified_attributes.map(&:attribute) # => [:email, :name]
+person = Person.new(name: 'a' * 500)
+person.truncate_attributes
+person.name # => 'a' * limit
 ```
 
-## Internals
+### `AttributeExtras::define_extra`
 
-If you want to register your own macros, you can do so with `AttributeExtras.register_extra`. Internally `attribute_extras` does this for the three macros listed above.
-
-### `:nullify` Example
+You can define your own extras by using the `define_extra` method on the `AttributeExtras` module. `define_extra` takes a name for the extra and a block which itself accepts three arguments (the record being modified, the attribute being modified, and the value of the attribute). The block should return the modified value. An example would be:
 
 ```ruby
-AttributeExtras.configure do |config|
-  config.register_extra :nullify, ->(value, options){ value.presence },
-    past: :nullified,
-    validator: { format: { allow_nil: true, without: /\A\s*\z/ } }
+AttributeExtras.define_extra :double_attributes do |_record, _attribute, value|
+  value * 2
 end
-```
 
-### `:truncate` Example
-
-```ruby
-AttributeExtras.configure do |config|
-  config.register_extra :truncate, ->(value, options){ value.is_a?(String) ? value[0...options[:limit]] : value },
-    past: :truncated,
-    validator: ->(options){ { length: { maximum: options[:limit] } } },
-    options: ->(attribute){ { limit: self.columns_hash[attribute.to_s].limit } }
+class Person < ActiveRecord::Base
+  double_attributes :age
 end
+
+person = Person.create(age: 5)
+person.age # => 10
+
+person = Person.new(age: 5)
+person.double_attributes
+person.age # => 10
 ```
 
-In this case the options is needed to build a hash of metadata about the attribute in question so that the validator option can change. The options hash is also passed in to the `truncate_attribute_extra` method so that you have access to that metadata.
+## 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.
 
-## Additional information
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-### Contributing
+## Contributing
 
-Contributions welcome! Please submit a pull request with tests.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddnewton/attribute_extras.
 
-### License
+## License
 
-MIT License.
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,27 +1,12 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
+# frozen_string_literal: true
 
-require 'rdoc/task'
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'AttributeExtras'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-Bundler::GemHelper.install_tasks
-
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
   t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 task default: :test

data/attribute_extras.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'lib/attribute_extras/version'
+
+version = AttributeExtras::VERSION
+repository = 'https://github.com/kddnewton/attribute_extras'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'attribute_extras'
+  spec.version       = version
+  spec.authors       = ['Kevin Newton']
+  spec.email         = ['kddnewton@gmail.com']
+
+  spec.summary       = 'Extra macros for auto attribute manipulation.'
+  spec.description   = <<~DOC
+    Builds macros to automatically manipulate your models' attributes.
+  DOC
+  spec.homepage      = repository
+  spec.license       = 'MIT'
+
+  spec.metadata      = {
+    'bug_tracker_uri' => "#{repository}/issues",
+    'changelog_uri' => "#{repository}/blob/v#{version}/CHANGELOG.md",
+    'source_code_uri' => repository,
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.files         =
+    Dir.chdir(__dir__) do
+      `git ls-files -z`.split("\x0").reject do |f|
+        f.match(%r{^(test|spec|features)/})
+      end
+    end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '> 3'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.12'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'attribute_extras'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/attribute_extras/version.rb

@@ -1,6 +1,5 @@
-module AttributeExtras
-
-  # current version of the gem
-  VERSION = '0.1.4'
+# frozen_string_literal: true
 
+module AttributeExtras
+  VERSION = '1.0.1'
 end