potter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd356cc421ff92e92441fd7539517877c1d969e4e772b44fc437e043c788c547
-  data.tar.gz: c25a9ff7843b5d13f91d791ec3169bdebbf9e2de1a073108044b37db21e0d856
+  metadata.gz: a23406491aa285780e485ed61cfe1fb6853cd975d6319bf9b3d940fff9202a5d
+  data.tar.gz: 7d25cad13739d71f78f8faabdbd39cc0f95ec317830a623d4137b13fda108f26
 SHA512:
-  metadata.gz: 01f79d0a653082150fb0e2a9de317d9c4212892f6acd7076aef68b8e525178c8df069fe143851c4a37e11afacbff1218089bc692440befa6092933421ace02a6
-  data.tar.gz: c61ee5de4b9765d4cd7688aebbcf71db66a40c99a866c78406537c199c21cfd27f31e5fa2e2ed1bbc2addd77d9fe99caa33bffe2f5ad071782c8a37ab810c71e
+  metadata.gz: deab47dc584ba58d04dd04423aac1ca28f841693faaa7fde01613080f0f360c560d59421fa4703775139aa5008451acb1a3b206783a01ace9870040cd710d73c
+  data.tar.gz: 57f40e4752edda31d00b4f3cdc79178d2519f75b61965fe65cce0b65d50359ae1a0347e8c969dcfd6067b0e560cbbe9036fe52c8aa8ed50de2d1f6ea8927036c

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  cnc: rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+4.0.1

data/README.md

@@ -1,39 +1,64 @@
-# Potter
+# 🏺 Potter
 
-TODO: Delete this and the text below, and describe your gem
+A gem for modeling anything: databases, CSVs, REST APIs, file systems.
 
-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/potter`. To experiment with that code, run `bin/console` for an interactive prompt.
+It's meant to be simple and compact.
 
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## 💎 Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add potter
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+If bundler is not being used to manage dependencies, install the gem by
+executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install potter
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+Start by declaring your models:
+
+```rb
+class Base
+  include Potter::API
+  root "https://"
+end
+
+class Transaction < Base
+  date       :date
+  belongs_to :merchant
+  string  :category
+  string  :account
+  string  :original_statement
+  string  :notes
+  float   :amount, scale: 2, note: "positive numbers for income and negative numbers for expenses"
+  string  :tags
+end
+```
 
 ## 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. 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).
+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]/potter.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/craft-concept/potter.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "minitest/test_task"
 
-RSpec::Core::RakeTask.new(:spec)
+Minitest::TestTask.create
 
-task default: :spec
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/db/migrate/20230109071230_create_requests.rb

@@ -0,0 +1,48 @@
+class CreateRequests < ActiveRecord::Migration[8.0]
+  def adapter
+    @adapter ||= ActiveRecord::Base.connection.adapter_name.downcase.then { ActiveSupport::StringInquirer.new _1 }
+  end
+
+  def change
+    methods = %w[get post put patch delete head options trace connect]
+    states  = %w[received queued sending responded failed]
+
+    unless adapter.sqlite?
+      create_enum :http_method, methods
+      create_enum :request_state, states
+    end
+
+    create_table :responses do |t|
+      t.string  :type, null: false
+      t.integer :status, null: false
+
+      t.jsonb :headers
+      t.text :body
+
+      t.timestamps
+
+      t.check_constraint %(status BETWEEN 0 AND 999), name: "valid_status"
+    end
+
+    create_table :requests do |t|
+      t.string :type, null: false, index: true
+      t.string :state, null: false
+      t.string :http_method, null: false
+      t.string :root, null: false, index: true
+      t.string :path, null: false, index: true
+
+      t.jsonb :params
+      t.jsonb :headers
+      t.text :body
+
+      t.references :response, foreign_key: true
+
+      t.timestamps
+
+      t.check_constraint %{http_method in (#{methods.map { "'#{_1}'" }.join(?,)})}, name: "http_method_enum"
+      t.check_constraint %{state in (#{states.map { "'#{_1}'" }.join(?,)})}, name: "state_enum"
+    end
+
+    add_index :requests, %i[type path params http_method]
+  end
+end

data/lib/potter/application_record.rb

@@ -0,0 +1,10 @@
+module Potter
+  if defined?(::ApplicationRecord)
+    ApplicationRecord = ::ApplicationRecord
+  else
+    require "active_record"
+    class ApplicationRecord < ActiveRecord::Base
+      primary_abstract_class
+    end
+  end
+end

data/lib/potter/ast/binary.rb

@@ -0,0 +1,35 @@
+module Potter
+  module AST
+    class Binary < Node
+      def initialize(left, right)
+        super()
+        @left  = left
+        @right = right
+      end
+
+      def walk
+        yield @left
+        yield @right
+      end
+
+      def eval = @left.eval.public_send(symbol, @right.eval)
+    end
+
+    def self.define_binary(const, symbol, name = const.underscore, &)
+      define_node(const, Binary, symbol:, name:, &)
+    end
+
+    define_binary :EqualTo,        :==, :eq
+    define_binary :GreaterThan,    :>,  :gt
+    define_binary :GreaterOrEqual, :>=, :gte
+    define_binary :LessThan,       :<,  :lt
+    define_binary :LessOrEqual,    :<=, :lte
+
+    define_binary :And,   :&
+    define_binary :Or,    :|
+    define_binary :Plus,  :+
+    define_binary :Minus, :-
+    define_binary :Times, :*
+    define_binary :Range, :".."
+  end
+end

data/lib/potter/ast/dsl.rb

@@ -0,0 +1,9 @@
+module Potter
+  module AST
+    module DSL
+      module_function
+
+      def Node(...) = AST.Node(...)
+    end
+  end
+end

data/lib/potter/ast/node.rb

@@ -0,0 +1,37 @@
+module Potter
+  module AST
+    class Node
+      def symbol = SYMBOL
+      def name   = NAME
+
+      def visit(visitor)
+        visitor.try(name, self)
+      end
+
+      def hash = [self.class, *instance_variable_values].hash
+
+      def eql?(o)
+        hash == o.hash
+      end
+    end
+
+    def self.define_node(const, parent = Node, symbol: nil, name: const.underscore, &)
+      define_class(const, parent) do
+        const_set(:SYMBOL, symbol) if symbol
+        const_set(:NAME,   name)   if name
+        class_exec(&) if block_given?
+        klass = self
+
+        if name
+          Node.define_method(name)  {|*args| Proxy klass.new(self, *args.map { Node _1 }) }
+          DSL.define_singleton_method(name)   {|*args| klass.new(*args.map { Node _1 }) }
+          Proxy.define_method(name) {|*args| Proxy klass.new(@node, *args.map { Node _1 }) }
+        end
+
+        if symbol
+          Proxy.define_method(symbol) {|*args| Proxy klass.new(@node, *args.map { Node _1 }) }
+        end
+      end
+    end
+  end
+end

data/lib/potter/ast/proxy.rb

@@ -0,0 +1,14 @@
+module Potter
+  module AST
+    class Proxy
+      attr_reader :node
+
+      def initialize(node)
+        @node = node
+      end
+
+      def Node(o) = AST.Node(o)
+      def Proxy(o) = AST.Proxy(o)
+    end
+  end
+end

data/lib/potter/ast/unary.rb

@@ -0,0 +1,21 @@
+module Potter
+  module AST
+    class Unary < Node
+      attr_reader :child
+
+      def initialize(child)
+        super()
+        @child = child
+      end
+
+      def eval = public_send(symbol)
+    end
+
+    def self.define_unary(const, symbol)
+      define_node(const, Unary, symbol:)
+    end
+
+    define_unary :Not, :!@
+    define_unary :Negate, :-@
+  end
+end

data/lib/potter/ast/value.rb

@@ -0,0 +1,13 @@
+module Potter
+  module AST
+    class Value < Node
+      attr_reader :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def eval = @value
+    end
+  end
+end

data/lib/potter/ast/variable.rb

@@ -0,0 +1,11 @@
+module Potter
+  module AST
+    class Variable < Node
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+    end
+  end
+end

data/lib/potter/ast.rb

@@ -0,0 +1,25 @@
+module Potter
+  module AST
+    module_function
+
+    def Proxy(o)
+      o.is_a?(Proxy) ? o : Proxy.new(Node o)
+    end
+
+    def Value(o)
+      o.is_a?(Value) ? o : Value.new(o)
+    end
+
+    def Node(o)
+      o.is_a?(Node) ? o : Value.new(o)
+    end
+
+    def Variable(o)
+      o.is_a?(Variable) ? o : Variable.new(o)
+    end
+
+    def proxy(o) = Proxy(o)
+    def value(o) = Value(o)
+    def var(o)   = Variable(o)
+  end
+end

data/lib/potter/caching.rb

@@ -0,0 +1,33 @@
+module Potter
+  concern :Caching do
+    # def full = cache(:full) { first + last }
+    def cache(name, &)
+      name = "@#{name}"
+      @_cached ||= []
+      @_cached << name
+      instance_variable_defined?(name) ?
+        instance_variable_get(name) :
+        instance_variable_set(name, instance_exec(&))
+    end
+
+    def clear_cache!
+      @_cached.each { remove_instance_variable(_1) }.clear
+    end
+
+    class_methods do
+      # derive :full, -> { first + last }
+      def derive(name, proc = nil, &block)
+        proc ||= block
+        define_method(name) { cache(name, &proc) }
+      end
+
+      # cache! def full = first + last
+      def cache!(name)
+        prepend Module.new.tap { _1.module_eval <<~RUBY }
+          def #{name} = cache(:#{name}) { super }
+        RUBY
+        name
+      end
+    end
+  end
+end

data/lib/potter/collections.rb

@@ -0,0 +1,29 @@
+module Potter
+  class Collection < Array
+    def self.filter(name, block)
+      define_method(name) do |*args|
+        filter { _1.instance_exec(*args, &block) }
+      end
+    end
+  end
+
+  module Collections
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def inherited(child)
+        super
+
+        child.class_eval <<-RUBY
+          class Collection < Collection
+          end
+        RUBY
+      end
+
+      def filter(...)   = Collection.filter(...)
+      def all(arr)      = Collection.new(arr)
+      def if(cond, ...) = cond ? instance_exec(cond, ...) : self
+      def to(...)       = map { _1.to(...) }
+    end
+  end
+end

data/lib/potter/core_ext/active_record.rb

@@ -0,0 +1,17 @@
+if defined? ::ActiveRecord::ConnectionAdapters::SQLite3
+  class ::ActiveRecord::ConnectionAdapters::SQLite3::TableDefinition
+    unless method_defined? :jsonb
+      def jsonb(name)
+        blob name
+        check_constraint %{json_valid(#{name}, 6)}, name: "#{name}_valid_json"
+      end
+    end
+
+    unless method_defined? :json
+      def json(name)
+        text name
+        check_constraint %{json_valid(#{name}, 6)}, name: "#{name}_valid_json"
+      end
+    end
+  end
+end

data/lib/potter/core_ext.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "cnc/core_ext"
+
+Dir.glob(File.expand_path("core_ext/*.rb", __dir__)).sort.each do |path|
+  require path
+end

data/lib/potter/csv.rb

@@ -0,0 +1,17 @@
+require "csv"
+
+module Potter
+  module CSV
+    extend ActiveSupport::Concern
+
+    class Table < ::CSV::Table
+    end
+
+    class Row < ::CSV::Row
+    end
+
+    def to_csv
+      Row.new(attributes.keys, attributes.values.map(&:presence))
+    end
+  end
+end

data/lib/potter/endpoints.rb

@@ -0,0 +1,8 @@
+module Potter
+  class Endpoints
+    def self.resources(name, only: nil)
+      @resources ||= []
+      @resources << {name:, only:}
+    end
+  end
+end

data/lib/potter/engine.rb

@@ -0,0 +1,15 @@
+require "rails"
+
+module Potter
+  class Engine < ::Rails::Engine
+    # config.autoload_paths += paths["lib"].to_a
+
+    initializer "potter.inflections" do
+      ActiveSupport::Inflector.inflections do |i|
+        i.acronym "AST"
+        i.acronym "DSL"
+        i.acronym "CSV"
+      end
+    end
+  end
+end

data/lib/potter/enum.rb

@@ -1,14 +1,12 @@
 module Potter
-  module Enum
-    def self.included(base)
-      base.extend ClassMethods
-    end
+  concern :Enum do
+    include Transformers
 
-    module ClassMethods
-      def next_id = @last_id ? @last_id += 1 : @last_id = 0
+    class_methods do
+      def next_id  = @prev_id ? @prev_id + 1 : 0
 
       def const(name, id = next_id, description: nil)
-        @last_id = id
+        @prev_id = id
         const_set(name, id)
       end
 
@@ -22,15 +20,14 @@ module Potter
       end
     end
 
-    def self.of(type)
-      parent = self
-      name = type.name.gsub("::", "")
-      const_get(name) ||
-        const_set(type.name.gsub("::", ""), Class.new(type) do
+    def self.of(type, &)
+      const_cache(type) do
+        parent = self
+        Class.new(type) do
           include parent
-        end)
+          class_exec(&) if block_given?
+        end
+      end
     end
   end
-
-  def self.Enum(type) = Enum.of(type)
 end

data/lib/potter/field.rb

@@ -0,0 +1,34 @@
+module Potter
+  class Field
+    include OptionHelpers
+
+    option :name, &:to_sym
+    option :type, -> { _1.is_a?(Class) ? _1.new : _1 }
+    option :default
+
+    option :enum
+    option :validates
+    option :normalizes
+
+    option :persist?, default: true
+    option :required?, default: -> { default.nil? }
+    option :declared?
+    option :description
+
+    def initialize(**)
+      assign_options!(**)
+    end
+
+    def optional? = !required?
+
+    def string? = type.type == :string
+
+    def record!(klass)
+      klass.attribute(name, type, default:)
+      klass.normalizes(name, **normalizes) if normalizes?
+      klass.validates(name, **validates) if validates?
+      klass.enum(name, enum) if enum?
+      self
+    end
+  end
+end

data/lib/potter/flag.rb

@@ -1,11 +1,9 @@
-require_relative "enum"
-
 module Potter
   module Flag
     include Enum
 
     module ClassMethods
-      def next_id = @last_id ? @last_id <<= 1 : @last_id = 1
+      def next_id = @prev_id ? @prev_id << 1 : 1
     end
   end
 

data/lib/potter/{endpoint.rb → index.rb}

@@ -1,4 +1,4 @@
 module Potter
-  class Endpoint
+  class Index
   end
 end

data/lib/potter/information_schema/base.rb

@@ -0,0 +1,11 @@
+module Potter
+  module InformationSchema
+    class Base < ActiveRecord::Base
+      # include Potter::Record
+      self.abstract_class     = true
+      self.table_name_prefix  = "information_schema."
+      self.param_delimiter    = "-"
+      self.inheritance_column = nil
+    end
+  end
+end

data/lib/potter/information_schema/index.rb

@@ -0,0 +1,9 @@
+module Potter
+  module InformationSchema
+    class Index < Base
+      self.table_name_prefix = nil
+      self.table_name = "pg_indexes"
+      self.primary_key = "indexname"
+    end
+  end
+end

data/lib/potter/information_schema/table.rb

@@ -0,0 +1,7 @@
+module Potter
+  module InformationSchema
+    class Table < Base
+      self.primary_key = %w[table_schema table_name]
+    end
+  end
+end

data/lib/potter/migrations.rb

@@ -0,0 +1,42 @@
+module Potter
+  module Migrations
+    extend ActiveSupport::Concern
+
+    class Migration < ActiveRecord::Migration[8.0]
+      def initialize(model)
+        @model = model
+      end
+
+      def column_names
+      end
+
+      def create_or_change_table(name, **, &)
+        return create_table(name, **, &) unless table_exists?(name)
+
+        change_table(name, **) do |t|
+          t.remove_columns(*(t.columns.map(&:name) - %w[id]))
+          yield t
+        end
+      end
+
+      def change
+        create_or_change_table(model.table_name) do |t|
+          model.fields.each do |f|
+            t.column f.name, f.type.to_sym, null: f.optional?
+          end
+        end
+      end
+    end
+
+    included do
+      unless defined?(table_name)
+        def self.table_name = name.tableize
+      end
+    end
+
+    class_methods do
+      def migrate!  = migration.migrate(:up)
+      def migration = Migration.new(self)
+    end
+  end
+end

data/lib/potter/model.rb

@@ -0,0 +1,16 @@
+module Potter
+  module Model
+    extend ActiveSupport::Concern
+
+    include Schema
+    include Collections
+    include Transformers
+    include CSV
+
+    included do
+      from Array do |values|
+        assign values.zip(fields.keys).to_h(&:reverse)
+      end
+    end
+  end
+end