arable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6902faa8ab5b48277e24a765c398d433af4dcdcda5ddff07db42e8e27a145481
+  data.tar.gz: c12e4b8086aadac55214f08e792f92f167ea5a055de4eff128e5dd224f81063f
+SHA512:
+  metadata.gz: 8c3db6a6754381c41b0856bebfb8b1d5f48c91c278590e7f3e96a241ad7cc7db8e84553eff5092ed690f22dd59a65f81d60f359d93a642cdb1afc1368b037935
+  data.tar.gz: 28a80481d6fb7bb8a2b2763d1133995150652028b58a44ea3f94b144f4c997a1dd0d86f87941b5527fc3fb54b97021770f8470b038583087234d31df72e2b1c0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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] - 2022-05-17
+
+- Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Danielius
+
+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,39 @@
+# Arable
+
+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/arable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arable'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install arable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/arable.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/arable/version.rb

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

data/lib/arable.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative "arable/version"
+
+module Arable
+  class Error < StandardError; end
+
+  SKIP_ARABLE_COLUMNS_CLASS_VAR_NAME = :@@skip_arable_columns
+
+  def self.models
+    ApplicationRecord.models.reject { _1.class_variable_defined?(SKIP_ARABLE_COLUMNS_CLASS_VAR_NAME) }
+  end
+
+  def self.column_names_from_schema(table_name)
+    table_definition_match =
+      File
+        .read('db/schema.rb')
+        .match(/create_table "#{table_name}".*?\n(.*?)\n *end/m)
+
+    columns =
+      table_definition_match[1]
+        .lines
+        .reject { |line| line.include?('t.index') }
+        .map { |line| line.match(/t\.[a-z]* "([a-z_]*)"/)[1] }
+
+    if table_definition_match[0].include?('id: false')
+      columns
+    else
+      ['id'] + columns
+    end
+  end
+
+  def self.included(klass)
+    return if klass.class_variable_defined?(SKIP_ARABLE_COLUMNS_CLASS_VAR_NAME)
+
+    column_names = column_names_from_schema(klass.table_name).map(&:to_sym)
+    illegal_names = column_names & klass.methods
+
+    if illegal_names.any?
+      Rails.logger.warn("#{klass} model has illegal column names: #{illegal_names}. Please rename these columns.")
+    end
+
+    (column_names - illegal_names).each do |name|
+      klass.define_singleton_method(name) do
+        klass.arel_table[name]
+      end
+    end
+  end
+
+  module ClassMethods
+    def skip_arable_columns!
+      class_variable_set(SKIP_ARABLE_COLUMNS_CLASS_VAR_NAME, true)
+    end
+
+    def star
+      arel_table[Arel.star]
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do |active_record|
+  def inherited(subclass)
+    super
+
+    subclass.extend(Arable::ClassMethods)
+
+    # include Arable only when the class has finished defining itself
+    ActiveSupport.on_load(subclass)
+    TracePoint.trace(:end) do |trace|
+      if subclass == trace.self
+        subclass.include(Arable)
+        trace.disable
+      end
+    end
+  end
+end

data/sig/arable.rbs

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: arable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danielius Visockas
+- Lukas Kairevičius
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-17 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- danieliusvisockas@gmail.com
+- lumzdas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/arable.rb
+- lib/arable/version.rb
+- sig/arable.rbs
+homepage: https://github.com/dvisockas/arable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/dvisockas/arable
+  source_code_uri: https://github.com/dvisockas/arable
+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.3.7
+signing_key: 
+specification_version: 4
+summary: Shorthand syntax to acces your arel tables directly
+test_files: []