data_files 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f09c5ae55f674a4ad8b4bc76254597886a23049ae89a7ed6d92721f441f12f28
-  data.tar.gz: b03aadea4384d63f6762a20661e5224a2e8d41649b1ad2ea68fae54062a47def
+  metadata.gz: 6bc77b2428d997de38f6a43403419c6309bfccfa7447cb05ff4a2400d554d4be
+  data.tar.gz: e8ad9473ff79bd780755e0bf363ffbd7ed9d4d36055d7e1a8c7ffa726b103d7b
 SHA512:
-  metadata.gz: 6a08f15a341afb32219e9ef96d2730895201c9a0b211c26bd457dd9784573dddc3f379fa480c473781d90d43e395e98c85a78c3a92f846c9637c63455ad1de9a
-  data.tar.gz: eebfa90ca1b931055cfd16b230541d53d313c1650f4e681a4d95ba6a49485866824505500ec9287e5e7273dd8032075188e2d47c12a5baf695a07cd3686f6d44
+  metadata.gz: 077d728c7dc6ec187a1f2022e2e5bb5c95f99552e485e427e466d9cf42a35c5648d0f4a33556f6f5d44cdc71b825e33adfb4eb9be24ebee27f9c3c92d4ae739a
+  data.tar.gz: 4acd129fe10323bf1615edf6a9acd0f607daf1b91d05b58142b91a6adc45acec5e516e7d1d896c99efd8347335fd5a58135b8866698d144afc318505e6f3d7e3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.1.0] - 2020-01-10
+### Added
+- Attribute value autocompletion for the ActiveData methods `where` and `find_by`.
+
 ## [1.0.0] - 2020-01-09
 ### Added
 - Initial release.

data/Gemfile

@@ -1,7 +1,7 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in data-files.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "minitest", "~> 5.0"
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    data_files (1.0.0.rc6)
+    data_files (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -54,6 +54,17 @@ The internal `_id` attribute is ephemeral and can change between different sessi
 #<Game title: "Super Mario Maker 2", url: "https://www.nintendo.com/games/detail/super-mario-maker-2-switch/", year: 2019, _id: 12>
 ```
 
+## Autocompletion
+
+The methods `where` and `find_by` support autocompletion for attribute values which can be invoked by pressing the TAB key. If several suggestions are available, the TAB key needs to be pressed twice to show the suggestions.
+
+```ruby
+> Game.where(title: "⇥
+A Light In Chorus                  Another World                      Donut County                       wipE'out
+Advance Wars                       BOXBOY!                            Firewatch                          
+Animal Crossing: New Leaf          Commander Keen in Goodbye, Galaxy  Xenon 2: Megablast
+```
+
 ## Creating new data
 
 We can add new items to our data file:

data/lib/data_files/active_data.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# Base class for data querying and manipulation.
 module DataFiles
+  # Base class for data querying and manipulation.
   class ActiveData
     attr_reader :errors
 

data/lib/data_files/autocompletion.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module DataFiles
+  # Provides attribute value autocompletion for the ActiveData methods where and find_by.
+  class Autocompletion
+    ALLOWED_METHODS = %w[where find_by'].freeze
+    REGEX_OPENING_PARENTHESIS_OR_WHITESPACE = /\(|\s/.freeze
+
+    ParsedInput = Struct.new(:klass_name, :method_name, :attribute_name, :attribute_value) do
+      def valid?
+        klass_name && method_name && attribute_name
+      end
+    end
+
+    def initialize
+      Readline.completion_append_character = ''
+      Readline.completion_proc = proc do
+        parsed = parse_input(Readline.line_buffer)
+
+        if parsed.valid?
+          suggestions(
+            parsed.klass_name,
+            parsed.method_name,
+            parsed.attribute_name,
+            parsed.attribute_value
+          )
+        else
+          []
+        end
+      end
+    end
+
+    def parse_input(input)
+      klass_name, remainder = input.split('.')
+      method_name, attribute_name, attribute_value = remainder&.split(REGEX_OPENING_PARENTHESIS_OR_WHITESPACE)
+      attribute_name = attribute_name&.sub(':', '')&.strip
+      attribute_value = attribute_value&.sub('"', '')&.sub('\'', '')
+
+      ParsedInput.new(klass_name, method_name, attribute_name, attribute_value)
+    end
+
+    def suggestions(klass_name, method_name, attribute_name, attribute_value)
+      return [] unless Object.const_defined?(klass_name)
+      return [] unless ALLOWED_METHODS.include?(method_name)
+
+      values = Object.const_get(klass_name).data.collect do |item|
+        item[attribute_name]
+      end
+
+      if attribute_value
+        values.select { |value| value.to_s.start_with?(attribute_value) }
+      else
+        values
+      end
+    end
+  end
+end

data/lib/data_files/repl.rb

@@ -4,10 +4,11 @@ require 'date'
 require 'readline'
 require 'yaml'
 require_relative 'active_data.rb'
+require_relative 'autocompletion.rb'
 
-# Loads all yaml files in given directory, creates ActiveData subclass
-# for each file and provides an interactive shell.
 module DataFiles
+  # Loads all yaml files in given directory, creates ActiveData subclass
+  # for each file and provides an interactive shell.
   class REPL
     def initialize(directory)
       @klass_names = []
@@ -43,6 +44,7 @@ module DataFiles
 
     def prompt
       initial_prompt
+      DataFiles::Autocompletion.new
       read_input
     end
 

data/lib/data_files/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DataFiles
-  VERSION = "1.0.0"
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_files
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andreas Zecher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies: []
 description: This interactive shell allows users to manipulate Middleman Data Files
   with an API similar to ActiveRecord.
@@ -32,6 +32,7 @@ files:
 - data_files.gemspec
 - exe/data_files
 - lib/data_files/active_data.rb
+- lib/data_files/autocompletion.rb
 - lib/data_files/repl.rb
 - lib/data_files/version.rb
 homepage: https://github.com/pixelate/data-files