lazy_record 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad81a7b0c3eb8a909fd99ba5cec96b772c649fae
+  data.tar.gz: d6da780999fd6cef493cc0192dd9f9a8ab1fac77
+SHA512:
+  metadata.gz: b33fd97c406b27bd2150500b329039b0420078fdd5d8fa8958d8f359061f6919bfc351c35b7f2df4e977fd7ad1d23345c24bc752929cbec5bdcafde4f986412f
+  data.tar.gz: 28d25026ef52d74f4837be47400f686e996e6de1374e78319db65fc8faeffc352cb1ef7b7fd500011b1de251d4b150985ec5d0bc3d58826ab489404c9e4cc1ac

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/LineLength:
+  Max: 85
+  Exclude:
+    - 'lazy_record.gemspec'
+    - 'spec/spec_helper.rb'

data/.ruby-gemset

@@ -0,0 +1 @@
+lazy_record

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.0

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lazy_record.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 M. Simon Borg
+
+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,41 @@
+# LazyRecord
+
+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/lazy_record`. 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 'lazy_record'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lazy_record
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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]/lazy_record.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'lazy_record'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lazy_record.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lazy_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lazy_record'
+  spec.version       = LazyRecord::VERSION
+  spec.authors       = ['M. Simon Borg']
+  spec.email         = ['msimonborg@gmail.com']
+
+  spec.summary       = 'Some ActiveRecord magic for your table-less POROs. WIP.'
+  spec.description   = 'Add some convenience macros for your POROs that cut down on boilerplate code. Method definition macros, more powerful attr_accessors, and easy associations between in-memory objects. Somewhat mocks the ActiveRecord API to make it feel comfortable and intuitive for Rails developers.'
+  spec.homepage      = 'https://www.github.com/msimonborg/lazy_record'
+  spec.license       = 'MIT'
+  spec.add_dependency             'activesupport'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/lazy_record.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'lazy_record/version'
+require 'lazy_record/associations'
+require 'lazy_record/attributes'
+require 'lazy_record/callbacks'
+require 'lazy_record/dynamic_modules'
+require 'lazy_record/methods'
+require 'lazy_record/scopes'
+require 'lazy_record/validations'
+require 'lazy_record/relation'
+require 'lazy_record/base'
+
+# Namespace
+class LazyRecord; end

data/lib/lazy_record/associations.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+class LazyRecord
+  # Set up in-memory associations between POROs.
+  module Associations
+    COLLECTION_MODULE_NAME   = :Collections
+    NESTED_ATTRS_MODULE_NAME = :NestedAttributes
+
+    def lr_has_many(*collections)
+      mod = get_or_set_and_include_mod(COLLECTION_MODULE_NAME)
+
+      mod.module_eval do
+        collections.each do |collection|
+          class_constant = collection.to_s.classify.constantize
+          define_method(collection) do
+            eval "@#{collection} ||= Relation.new(model: class_constant)"
+          end
+
+          define_method("#{collection}=") do |coll|
+            if coll.is_a? Array
+              coll = Relation.new(model: class_constant, array: coll)
+            end
+            if coll.is_a? Relation
+              instance_variable_set('@' + collection.to_s, coll)
+            else
+              raise ArgumentError, "Argument must be a collection of #{collection}"
+            end
+          end
+        end
+      end
+    end
+
+    def lr_accepts_nested_attributes_for(*collections)
+      mod = get_or_set_and_include_mod(NESTED_ATTRS_MODULE_NAME)
+
+      mod.module_eval do
+        collections.each do |collection|
+          class_constant = collection.to_s.classify.constantize
+          define_method("#{collection}_attributes=") do |collection_attributes|
+            collection_attributes.values.each do |attributes|
+              eval "@#{collection} << #{class_name}.new(attributes)"
+            end
+            collection
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lazy_record/attributes.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+class LazyRecord
+  # Add special attr_accessors that automatically add initialization options
+  # to your initialize method. Using lr_attr_accessor, you automatically get
+  # an #initialize method that takes setter options for each attribute and
+  # yields self to a block. If you want to add custom functionality to
+  # #initialize just call super.
+  module Attributes
+    ATTR_MODULE_NAME = :DynamicAttributes
+
+    def lr_attr_accessor(*names)
+      mod = get_or_set_and_include_mod(ATTR_MODULE_NAME)
+
+      mod.module_eval do
+        names.each do |name|
+          define_method(name) do
+            instance_variable_get('@' + name.to_s)
+          end
+
+          define_method("#{name}=") do |val|
+            instance_variable_set('@' + name.to_s, val)
+          end
+        end
+
+        define_method(:instance_attr_accessors) do
+          names.map(&:to_sym)
+        end
+
+        def initialize(opts = {})
+          instance_attr_accessors.each do |attr|
+            send("#{attr}=", opts[attr.to_sym])
+          end
+
+          yield self if block_given?
+          self
+        end
+
+        def instance_attrs_to_s
+          instance_attr_accessors.map do |attr|
+            value = send(attr)
+            attr_to_s = if value.is_a?(String)
+                          "\"#{value}\""
+                        elsif value.nil?
+                          'nil'
+                        else
+                          value
+                        end
+            "#{attr.to_s.delete(':')}: #{attr_to_s}"
+          end
+        end
+
+        private :instance_attr_accessors, :instance_attrs_to_s
+      end
+    end
+  end
+end

data/lib/lazy_record/base.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+class LazyRecord
+  # Inherit from LazyRecord::Base to achieve lazier development.
+  #
+  # LazyRecord gives you some ActiveRecord-style conveniences for your in-memory
+  # POROs. These include more powerful attr_accessors, object caching, instance
+  # method generating macros, scope methods and scope chaining, associations
+  # with other objects, and validations. This is a WIP still in development.
+  class Base
+    extend Scopes
+    extend Attributes
+    extend Associations
+    extend Callbacks
+    extend Validations
+    extend Methods
+    extend DynamicModules
+
+    class << self
+      attr_reader :all
+    end
+
+    attr_writer :id
+
+    def self.count
+      @all.count
+    end
+
+    def self.first
+      @all.first
+    end
+
+    def self.last
+      @all.last
+    end
+
+    def self.where(condition)
+      @all.where(condition)
+    end
+
+    def initialize
+      yield self if block_given?
+    end
+
+    def instance_attrs_to_s
+      []
+    end
+
+    def instance_attr_accessors
+      []
+    end
+
+    def id
+      @id.freeze
+    end
+
+    private :id=
+
+    def inspect
+      "#<#{self.class} id: #{id ? id : 'nil'}, #{instance_attrs_to_s.join(', ')}>"
+    end
+  end
+end

data/lib/lazy_record/callbacks.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+class LazyRecord
+  # After #initialize callbacks for validations and setting object id.
+  module Callbacks
+    def inherited(klass)
+      class << klass
+        alias_method :__new, :new
+
+        def new(opts = {}, &block)
+          @all ||= Relation.new(model: self)
+          instance = __new(opts, &block)
+          if instance.respond_to?(:validation)
+            instance = instance.validation(*@validations)
+          end
+          add_id(instance)
+        end
+
+        def add_id(instance)
+          if instance
+            all << instance
+            instance.send(:id=, count)
+          end
+          instance
+        end
+
+        private :add_id
+      end
+    end
+  end
+end

data/lib/lazy_record/dynamic_modules.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+class LazyRecord
+  # Generate dynamic modules for dynamic methods created with #define_method,
+  # for insertion into inheritance chain. This allows you to make calls to
+  # super for these methods.
+  module DynamicModules
+    def get_or_set_and_include_mod(module_name)
+      if const_defined?(module_name, _search_ancestors = false)
+        const_get(module_name)
+      else
+        mod = const_set(module_name, Module.new)
+        include mod
+        mod # return the Module for variable assignment.
+      end
+    end
+  end
+end

data/lib/lazy_record/methods.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+class LazyRecord
+  # Macro for dynamic instance method generation. Best to use for one-liners.
+  module Methods
+    METHODS_MODULE_NAME = :DynamicMethods
+
+    def can_multiply
+      mod = get_or_set_and_include_mod(METHODS_MODULE_NAME)
+
+      mod.module_eval do
+        define_method(:multiply) do |num1, num2|
+          num1 * num2
+        end
+      end
+    end
+
+    def lr_method(method_name, *args, method)
+      mod = get_or_set_and_include_mod(METHODS_MODULE_NAME)
+
+      args = args.map(&:to_s).join(', ')
+
+      if method.respond_to?(:call)
+        mod.module_eval do
+          send(:define_method, method_name, &method)
+        end
+      else
+        mod.module_eval do
+          define_method(method_name) do |*params|
+            block = eval("lambda { |#{args}| #{method} }")
+            block.call(*params)
+          end
+        end
+      end
+    end
+  end
+end