activerecord_squared 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7368d7970a209d6b71cfa873affb3008ffca8021ad09fe3562876680c2cba15c
+  data.tar.gz: 7f17f52c409bacc250b09b42a4352712555b5aa5bd67231a9919587a480d8911
+SHA512:
+  metadata.gz: 317f033959b5f586b75eb7a72bbe4af848fa8af652aeba80e2f3c4f26e5ec28ec8bd8278e39c2f0b016ce07274bde3e57f10dcb134c9e53b042063252e967d4c
+  data.tar.gz: f86d6456c4d689ed33497ba4364e1b25a92e5dad692e5d9fa80fd0a613a631b18478ef4ea371b010c4c3924d469d939e0e1fd962ae4d18b661c259a3bff5e672

data/README.md

@@ -0,0 +1,41 @@
+# ActiverecordSquared
+Tired of typing ```SomeModel.find_by(id: 12)```? Yeah man me too.
+
+Even ```SomeModel.find(12)``` still a bit too long?
+
+Wonder why you have to have 2 different methods for find and find_by, when it ought to be reasonably obvious which is called purely by the argument??
+
+Man do we have the solution for you. Introducing...ActiveRecord...squared!...the gem that adds a class-level square bracket method to ActiveRecord objects!
+
+What does it do? Now you can replace that with ```SomeModel[12]```. Also, you can, with zero added effort say: ```SomeModel[email_address: 'man_email_sucks@example.com']```! Revolutionary! You can do ```SomeModel[params[:id].present?``` - and ... even if the param is nil, it doesn't error out. You can even do a ```SomeModel[]``` to get everything. Stuff you could already do, but ... esier and more elegant! Great!
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_squared'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install activerecord_squared
+```
+
+## Usage
+There are 2 main modes for this, and they are based on what is passed in the bracket:
+
+Singular Identifier
+: Either a string or integer (most likely) - similar to calling ```SomeModel.where()```. This is the default mode. One of the more interesting options here is the ability to call ```SomeModel[params[:id]]``` - with nil as the id, and get ... nil. Not an error, like you'd get with find, but nil.
+
+Finder Hash
+: Similar to calling ```SomeModel.find_by()```.
+
+Of course, as this is ActiveRecord, they all return activerecord queries, not actual objects...and can thus be chained appropriately (though ... it's not terribly recommended - this is a shorthand - if you're gonna chain stuff, you probably want to be explicit).
+
+## 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,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/activerecord_squared.rb

@@ -0,0 +1,7 @@
+require "activerecord_squared/version"
+require "activerecord_squared/railtie"
+require 'activerecord_squared/activerecord_ext'
+
+module ActiverecordSquared
+  # Your code goes here...
+end

data/lib/activerecord_squared/activerecord_ext.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  class Base
+    def self.[](input)
+      case input
+      when nil
+        # Specifically enables ```SomeModel[nil]``` to not error out.
+        return nil
+      when ::Hash
+        return self.where(input)
+      else
+        return self.find(input)
+      end
+    end
+  end
+end

data/lib/activerecord_squared/railtie.rb

@@ -0,0 +1,4 @@
+module ActiverecordSquared
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/activerecord_squared/version.rb

@@ -0,0 +1,3 @@
+module ActiverecordSquared
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_squared
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Schultz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+description: Adds a [] method at the class level for activerecord objects.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/activerecord_squared.rb
+- lib/activerecord_squared/activerecord_ext.rb
+- lib/activerecord_squared/railtie.rb
+- lib/activerecord_squared/version.rb
+homepage: https://github.com/MatthewSchultz/activerecord_squared
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MatthewSchultz/activerecord_squared
+  source_code_uri: https://github.com/MatthewSchultz/activerecord_squared
+  changelog_uri: https://github.com/MatthewSchultz/activerecord_squared/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A shortcut for activerecord find.
+test_files: []