arable 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e759cee16589d2e4a6938fa4fdd8299e7265212cd9eab8313fd5bd8bf8b22836
-  data.tar.gz: 20609ecbdca2c5c47b858d7d041a10e51f0c3c6a90fc447e25132e54c419175d
+  metadata.gz: 251d0bedc4f15c2f3cb447c5a5edd8c4c08febdfb4e81a22b41fd93e691d17d7
+  data.tar.gz: 9a6e43bfc59dd51a7d94425b67d448a3f0c6789728dadd4a2a37bfe1163d10e9
 SHA512:
-  metadata.gz: d0d31fceda28bfc71b997b27ef8de06965e4663b0b25e913aecea6467347161540877090f4b54633f7ced28e7110be493c13ba70a30166d452c2d40e80ddaa2a
-  data.tar.gz: 8a662ef630e48b470c6057575fc83c967aedfaa46544f470eacab9e667d5ab4ce8b778cdc3fccd5f3000fd0a50f4f184be3b260d21b265ec2700b79e66c3ee13
+  metadata.gz: 8e78101a34628e9b92c45cb5c93db9b90e9fbd7928fc7ab4d38fbff8cfdfaca04e1507e02640b2280f44c7b62a77ab0c240e9e6331b892122fb4be0c110352cb
+  data.tar.gz: bb4e6bfa658771a4a11f6b07cb509cf3c937a799e91f9a503687acfec21029480d7dd1ab5becbf0d163bacf17089db63aa8a249661d033d8b43a3c8ea1242ec4

data/CHANGELOG.md

@@ -3,3 +3,8 @@
 ## [0.1.0] - 2022-05-17
 
 - Initial release
+
+
+## [0.2.0] - 2022-08-17
+
+- Add support for structure.sql

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    arable (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.4.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  arable!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.8

data/README.md

@@ -1,8 +1,6 @@
 # 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
+The days of writing `.arel_table` are gone! Arable enables you to write cleaner Arel (SQL) queries.
 
 ## Installation
 
@@ -16,17 +14,44 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Extend `ApplicationRecord`, `ActiveRecord::Base` or your base class that is being used by the models:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+    ...
+    extend Arable::ActiveRecordExtension
+    ...
+end
 
-    $ gem install arable
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+If you have a model `User birthday:date`, from now on you can use `User.birthday` directly. This acts as a shorthand for `User.arel_table[:birthday]`:
+
+```ruby
+def birthdays
+    User.where(User.birthday.eq(Date.today))
+end
+```
+
+This goes very well together with [arel-extensions gem](https://github.com/Faveod/arel-extensions). If you have both, you can write:
+
+```ruby
+def legal_aged_users
+    User.where(User.birthday <= 18.years.ago)
+end
+```
+
+## Roadmap
+
+[x] Support schema.rb
+[x] Support structure.sql
+[] Add tests
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests (which are coming soon). 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).
 

data/lib/arable/columns/from_schema.rb

@@ -0,0 +1,32 @@
+require_relative "../columns"
+require_relative "paths"
+
+module Arable::Columns::FromSchema
+  module_function
+
+  def call(table_name)
+    return if schema.blank?
+
+    table_definition_match = schema.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] }
+
+    return columns if table_definition_match[0].include?("id: false")
+
+    ["id"] + columns
+  end
+
+  private
+
+  def self.schema
+    @schema ||= begin
+      return unless File.exist?(Arable::Columns::Paths::SCHEMA)
+
+      File.read(Arable::Columns::Paths::SCHEMA)
+    end
+  end
+end

data/lib/arable/columns/from_structure.rb

@@ -0,0 +1,27 @@
+require_relative "../columns"
+require_relative "paths"
+
+module Arable::Columns::FromStructure
+  module_function
+
+  def call(table_name)
+    return if structure.blank?
+
+    table_definition_match = structure.match(/CREATE TABLE\s\w+\.#{table_name}.*?\n(.*?)\n *\);/m)
+
+    table_definition_match[1]
+      .lines
+      .map(&:strip)
+      .map { |line| line.match(/(\w*)\s/)[1] }
+  end
+
+  private
+
+  def self.structure
+    @structure ||= begin
+      return unless File.exist?(Arable::Columns::Paths::STRUCTURE)
+
+      File.read(Arable::Columns::Paths::STRUCTURE)
+    end
+  end
+end

data/lib/arable/columns/parser.rb

@@ -0,0 +1,16 @@
+require_relative "../columns"
+require_relative "from_schema"
+require_relative "from_structure"
+require_relative "paths"
+
+module Arable::Columns::Parser
+  WARN_MESSAGE = "No schema definition found, looked in #{Arable::Columns::Paths::ALL.join(', ')}".freeze
+
+  module_function
+
+  def call(table_name)
+    Arable::Columns::FromSchema.call(table_name) ||
+      Arable::Columns::FromStructure.call(table_name) ||
+      Rails.logger.warn(WARN_MESSAGE)
+  end
+end

data/lib/arable/columns/paths.rb

@@ -0,0 +1,11 @@
+require_relative "../columns"
+
+module Arable::Columns::Paths
+  SCHEMA = 'db/schema.rb'.freeze
+  STRUCTURE = 'db/structure.sql'.freeze
+
+  ALL = [
+    SCHEMA,
+    STRUCTURE,
+  ].freeze
+end

data/lib/arable/columns.rb

@@ -0,0 +1,2 @@
+module Arable::Columns
+end

data/lib/arable/version.rb

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

data/lib/arable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "arable/version"
+require_relative 'arable/version'
+require_relative 'arable/columns/parser'
 
 module Arable
   class Error < StandardError; end
@@ -13,29 +14,10 @@ module Arable
       .reject { |model| model.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)
+    column_names = Arable::Columns::Parser.call(klass.table_name).map(&:to_sym)
     illegal_names = column_names & klass.methods
 
     if illegal_names.any?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arable
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Danielius Visockas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-17 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -23,11 +23,17 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - arable-0.1.0.gem
 - lib/arable.rb
+- lib/arable/columns.rb
+- lib/arable/columns/from_schema.rb
+- lib/arable/columns/from_structure.rb
+- lib/arable/columns/parser.rb
+- lib/arable/columns/paths.rb
 - lib/arable/version.rb
 - sig/arable.rbs
 homepage: https://github.com/dvisockas/arable
@@ -37,6 +43,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/dvisockas/arable
   source_code_uri: https://github.com/dvisockas/arable
+  changelog_uri: https://github.com/dvisockas/arable
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -52,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.20
 signing_key: 
 specification_version: 4
 summary: Shorthand syntax to acces your arel tables directly