local_model 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23ec22d2650b17792c2a03dff88d9dffbcedd78b08ebd05afd057fd124d0476a
-  data.tar.gz: 8c89b6eaf25891cb05c3692785d9e88979372be6078ea465d080e9fbd9a7f330
+  metadata.gz: 52fd36165c3ec49f275a899b9c687e99e91942c64d603542f5295dfbd6b4070a
+  data.tar.gz: 26992202b57f21466187744566b20f1be8a2701d15a3cb6975dcd4f5f389d902
 SHA512:
-  metadata.gz: 6b770b1003097729755a6a63df94b909c58eb2c39ae64f398db5ff64083b2846307b173d8da3bd3533efa30ba4dce9dce2170f69ac3e6cc61d886d2b4cf08d5c
-  data.tar.gz: 405d6229dbb39b63e8fc5b9dd01d0e3dadaedf06907519f85a411a0d0547c7a1c12d6b1e7528d11f50a6d2e1cfe79f13526f5dcd6e919e1e91125ec9c03290b5
+  metadata.gz: 34dfb6506d823c13ecbe82869a7a60d3047e3842df78af576e7cf8b463422736bd95e103ef38b5ce57373e03f3a9d957ba83235984caec258aa593b348206d39
+  data.tar.gz: 989578a3bab8d8bb7d60fc1556b2f28c0c0e718f9c2d0054b178c1e2a460857fba0108198ce9ed13c5c0b7adec08a9f3ce21eaf8e3cb46bca9d0f871f754a83f

data/Gemfile

@@ -9,3 +9,5 @@ gemspec
 gem "pry", "~> 0.14.1", group: :development
 
 gem "irb", "~> 1.3"
+
+gem "thor", "~> 1.2"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    local_model (0.1.10)
+    local_model (0.1.13)
 
 GEM
   remote: https://rubygems.org/
@@ -31,6 +31,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    thor (1.2.1)
 
 PLATFORMS
   x86_64-linux
@@ -42,6 +43,7 @@ DEPENDENCIES
   pry (~> 0.14.1)
   rake (~> 13.0)
   rspec (~> 3.10)
+  thor (~> 1.2)
 
 BUNDLED WITH
-   2.2.17
+   2.3.14

data/README.md

@@ -1,9 +1,5 @@
 # LocalModel
 
-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/local_model`. 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:
@@ -22,6 +18,36 @@ Or install it yourself as:
 
 ## Usage
 
+Use the generator:
+
+```bash
+bundle add local_model
+```
+```
+bundle exec local_model --namespace DesiredNamespace
+``` 
+Note: `--namespace` is optional and will default to `InMemory`
+This creates a rails initializer which sets some config options,
+and a `DataAccessor` class which you can use to switch between your `LocalModel` objects and your `ActiveRecord` objects.
+
+Recommend adding: 
+
+`config/application.rb`
+```ruby
+config.autoload_paths << config.root.join('lib')
+```
+
+so you get all of these files.
+
+You can set an environment variable `USE_LOCAL_MODELS` to `true` or `false` to globally decide what to use.
+
+
+You also now can use a rake task to generate your `LocalModel` models:
+`rake local_model:create_model\[User\]`
+(The `\`s should only be necessary in zsh, not bash)
+
+OR, you can manually: 
+
 Create your schema:
 
 ```rb

data/Rakefile

@@ -5,9 +5,12 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
-desc "run a console"
-task :console do
-  require 'pry'
+desc "environment"
+task :environment do 
   require_relative './lib/local_model.rb'
-  binding.pry
+end
+
+desc "run file generator"
+task :generate => :environment do 
+  LocalModel::Generator.new.invoke_all
 end

data/bin/local_model

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'local_model'
+
+LocalModel::Generators::Initialize.start

data/lib/local_model/adapters/float_adapter.rb

@@ -5,7 +5,8 @@ class LocalModel::FloatAdapter
   end
 
   def self.read(flstr)
-    flstr =~ /[^0-9\.]/ ? nil :  flstr.to_f
+    str = flstr.strip
+    str =~ /^[+-]?([1-9]\d*|0)(\.\d+)?$/ ? str.to_f : nil
   end
 
 end

data/lib/local_model/collection.rb

@@ -26,7 +26,7 @@ class LocalModel::Collection < Array
     end
 
     def where(**args)
-        self.filter do |el|
+        arr = self.filter do |el|
             found = true
             args.each do |k,v|
                 if el.send(k.to_s) != v
@@ -36,6 +36,24 @@ class LocalModel::Collection < Array
             end
             found
         end
+        self.class.create_from(
+            array: arr,
+            for_model: model,
+            for_collection_class: nil,
+            add_to_collection_proc: ->(a,b) { raise NoMethodError.new("Cannot add to this collection") }
+        )
+    end
+
+    def find_by(**args)
+        where(**args).first
+    end
+
+    def first
+        self[0]
+    end
+
+    def last
+        self[-1]
     end
 
 end

data/lib/local_model/csv.rb

@@ -37,6 +37,10 @@ class LocalModel::CSV < LocalModel::Model
       schema_data
     end
 
+    self.define_method :schema_defaults do 
+      builder.defaults
+    end
+
     if !File.file?(self.storage_path)
       CSV.open(self.storage_path, 'wb') do |csv|
         csv << cols.map(&:to_s)
@@ -63,7 +67,7 @@ class LocalModel::CSV < LocalModel::Model
   end
 
   def self.where(**args)
-    all_records do |row|
+    arr = all_records do |row|
       found = true
       args.each do |k,v|
         if row[k] != v
@@ -73,6 +77,12 @@ class LocalModel::CSV < LocalModel::Model
       end
       found
     end.map{|r| new_from_record(r) }
+    LocalModel::Collection.create_from(
+      array: arr,
+      for_model: self,
+      for_collection_class: nil,
+      add_to_collection_proc: ->(a,b) { raise NoMethodError.new("Cannot add to this collection") }
+    )
   end
 
   def self.find_by(**args)
@@ -108,11 +118,7 @@ class LocalModel::CSV < LocalModel::Model
   end
 
   def self.find(id)
-    return self.find_by(id: id)
-  end
-
-  def self.find!(id)
-    found_record = find(id)
+    found_record = self.find_by(id: id)
     if !found_record
       raise LocalModel::RecordNotFound.new
     else
@@ -120,6 +126,14 @@ class LocalModel::CSV < LocalModel::Model
     end
   end
 
+  def self.find_or_create_by(**args)
+    found_obj = find_by(**args)
+    return found_obj if found_obj
+    create(**args)
+  end
+
+  # TODO: Move necessary methods to model.rb
+
   def self.create(**args)
     inst = new(**args)
     inst.save
@@ -133,6 +147,9 @@ class LocalModel::CSV < LocalModel::Model
   end
 
   def initialize(**args)
+    self.schema_defaults.each do |property, value|
+      self.send("#{property}=", value)
+    end
     args.each do |k,v|
       self.send("#{k}=", v)
     end
@@ -145,7 +162,7 @@ class LocalModel::CSV < LocalModel::Model
   
   def reload
     raise LocalModel::RecordNotFound if !self.id
-    self.class.find!(self.id)
+    self.class.find(self.id)
   end
 
   def destroy

data/lib/local_model/generators/initialize.rb

@@ -0,0 +1,32 @@
+require 'thor'
+require 'thor/group'
+
+module LocalModel
+    module Generators
+        class Initialize < Thor::Group
+            include Thor::Actions
+
+            class_option :namespace, default: "InMemory"
+
+            desc 'Create required files'
+
+            def self.source_root
+                File.dirname(__FILE__) + '/../'
+            end
+
+            def create_initializer
+                @namespace_classname = options[:namespace]
+                template('templates/initializer.erb', 'config/initializers/local_model.rb')
+            end
+
+            def create_data_accessor
+                template('templates/data_accessor.erb', 'lib/data_accessor.rb')
+            end
+
+            def create_model_generator
+                @class_namespace_snake = LocalModel::Functions.camel_to_snake(@namespace_classname)
+                template('templates/generate_model.erb', 'lib/tasks/local_model.rake')
+            end
+        end
+    end
+end

data/lib/local_model/helpers/pluralized_words.rb

@@ -24,7 +24,6 @@ class LocalModel::PluralizedWords
     "moves" => "move",
     "groves" => "grove",
     "stoves" => "stove",
-    "beliefs" => "belief"
   }
 
    IRREGULAR_PLURALIZED_WORDS = {

data/lib/local_model/model.rb

@@ -33,7 +33,7 @@ class LocalModel::Model
         association_class = Object.const_get(association_class_name)
       end
       id = self.send(keyname)
-      association_class.find(id)
+      association_class.find_by(id: id)
     end
 
     define_method "#{association}=" do |association_obj|
@@ -91,7 +91,7 @@ class LocalModel::Model
       define_method association do 
         association_class = Object.const_get(association_classname)
         LocalModel::Collection.create_from(
-          array: self.send(through).map{|through_obj| association_class.find(through_obj.send(belongs_to_id_sym))},
+          array: self.send(through).map{|through_obj| association_class.find_by(id: through_obj.send(belongs_to_id_sym))},
           for_model: self,
           for_collection_class: association_class,
           add_to_collection_proc: add_to_collection
@@ -192,37 +192,47 @@ class LocalModel::Model
   class SchemaBuilder
 
     attr_reader :schema
+    attr_reader :defaults
 
     def initialize(model)
       @model = model
       @schema = { id: :integer }
       @model.attr_accessor :id
+      @defaults = {}
     end
 
-    def string(name)
+    def set_default(name, default)
+      @defaults[name] = default if !default.nil?
+    end
+
+    def string(name, default: nil)
       @model.attr_accessor name
       @schema[name] = :string
+      set_default(name, default)
     end
 
-    def integer(name)
+    def integer(name, default: nil)
       @model.attr_accessor name
       @schema[name] = :integer
+      set_default(name, default)
     end
 
-    def boolean(name)
+    def boolean(name, default: nil)
       @model.attr_accessor name
       @schema[name] = :boolean
+      set_default(name, default)
     end
 
-    def float(name)
+    def float(name, default: nil)
       @model.attr_accessor name
       @schema[name] = :float
+      set_default(name, default)
     end
 
-    def datetime(name)
+    def datetime(name, default: nil)
       @model.attr_accessor name
       @schema[name] = :datetime
+      set_default(name, default)
     end
-
   end
-end
+end

data/lib/local_model/templates/data_accessor.erb

@@ -0,0 +1,61 @@
+module DataAccessor
+    class Base
+        class Accessors
+            LOCAL = :local
+            ACTIVE_RECORD = :active_record
+
+            NAMESPACES = {
+                LOCAL => <%= @namespace_classname %>,
+                ACTIVE_RECORD => Object
+            }
+
+        end
+
+        @@strategy = ENV["USE_LOCAL_MODELS"] ? Accessors::LOCAL : Accessors::ACTIVE_RECORD
+        @@exceptions = Set.new([])
+
+        def self.set_strategy(strat)
+            if strat.to_sym == :local
+                @@strategy = Accessors::LOCAL
+            else
+                @@strategy = Accessors::ACTIVE_RECORD
+            end
+        end
+
+        def self.klass(klass_name)
+            namespace = get_namespace_for(klass_name)
+            namespaced_klass_name = "#{namespace}::#{klass_name.to_s}" 
+            namespaced_klass = Object.const_get(namespaced_klass_name)
+        end
+        private_class_method :klass
+
+        def self.get_namespace
+            Accessors::NAMESPACES[@@strategy]
+        end
+        private_class_method :get_namespace
+
+        def self.get_namespace_for(klass)
+            exception_strategy = @@strategy == Accessors::ACTIVE_RECORD ? Accessors::LOCAL : Accessors::ACTIVE_RECORD
+            exception_namespace = Accessors::NAMESPACES[exception_strategy]
+            if @@exceptions.include?(klass.to_s.to_sym) 
+                exception_namespace
+            else
+                get_namespace
+            end
+        end
+        private_class_method :get_namespace_for
+
+        def self.set_exceptions(exceptions)
+            @@exceptions = Set.new(exceptions.map(&:to_sym))
+        end
+
+        # Example - find user
+        # def self.find_user(id)
+        #    ref = klass(:User)
+        #    ref.find(id)
+        # end
+        # private_class_method :find_user
+
+        # MARK: PUBLIC GETTERS
+    end
+end

data/lib/local_model/templates/generate_model.erb

@@ -0,0 +1,20 @@
+
+namespace :local_model do 
+
+    desc "Generate LocalModel model" 
+    task :create_model, [:klass_name] => :environment do |_t, args|
+        klass_name = args[:klass_name]
+        model_code = <<~RUBY
+        class <%= @namespace_classname %>::#{klass_name} < LocalModel::CSV
+            schema do |t|
+
+            end
+        end
+        RUBY
+
+        dir = Rails.root.join('lib', '<%= @class_namespace_snake%>')
+        Dir.mkdir(dir) unless File.exists?(dir)
+        filename = "#{dir}/#{klass_name.underscore}.rb"
+        File.open(filename, 'w')  { |f| f.write(model_code) }
+    end
+end

data/lib/local_model/templates/initializer.erb

@@ -0,0 +1,7 @@
+module <%= @namespace_classname %>
+    LocalModel.config do |c|
+        c.path = "./tmp/#{ENV['RAILS_ENV'] || 'development'}"
+        c.namespace = "<%= @namespace_classname %>"
+        c.cleanup_on_start = false
+    end
+end

data/lib/local_model/version.rb

@@ -1,3 +1,3 @@
 module LocalModel
-  VERSION = "0.1.12"
+  VERSION = "0.1.14"
 end

data/lib/local_model.rb

@@ -14,6 +14,7 @@ require_relative './local_model/helpers/functions'
 require_relative './local_model/helpers/pluralized_words'
 require_relative './local_model/model'
 require_relative './local_model/csv'
+require_relative './local_model/generators/initialize'
 
 module LocalModel
   class Error < StandardError; end

data/local_model.gemspec

@@ -30,8 +30,11 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  # spec.bindir        = "exe"
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables << 'local_model'
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: local_model
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - Micah Shute
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,7 +56,10 @@ description: This is meant to help facilitate an API-first strategy when creatin
   web apps with RoR
 email:
 - micah.shute@gmail.com
-executables: []
+executables:
+- console
+- local_model
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,6 +73,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/local_model
 - bin/setup
 - lib/local_model.rb
 - lib/local_model/adapters/boolean_adapter.rb
@@ -82,10 +86,14 @@ files:
 - lib/local_model/csv.rb
 - lib/local_model/errors/record_invalid.rb
 - lib/local_model/errors/record_not_found.rb
+- lib/local_model/generators/initialize.rb
 - lib/local_model/helpers/functions.rb
 - lib/local_model/helpers/pluralized_words.rb
 - lib/local_model/model.rb
 - lib/local_model/sandbox.rb
+- lib/local_model/templates/data_accessor.erb
+- lib/local_model/templates/generate_model.erb
+- lib/local_model/templates/initializer.erb
 - lib/local_model/version.rb
 - local_model.gemspec
 homepage: https://github.com/micahshute/local_model