active_record_lite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b2e70191758bf10f9226b2498e7bf8b6fa751493e66a82d47913f7e63a39016
+  data.tar.gz: c11cff4b26e8adad2482837e1015c5b6bf32a8cd7e3022668cb3db942266b1a2
+SHA512:
+  metadata.gz: f02bba0706f6250bcc55e6cac39242e9522ab114e6909a76899760f303be7c61b6df4d4e96b55f445649df800c17f1f3ff995f7b1101fbcc21606509a5518bcf
+  data.tar.gz: e1d7e8add388fc91d894b652d4b695ca0bac3a64296d58348d090279cdb960e28d8330a8e8a4c2b1611e10a2f5650563a764b913c2a1500c14b27416aadc9889

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ritikeshsisodiya@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_record_lite.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'sqlite3', '1.3.9'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ritikesh
+
+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,97 @@
+# ActiveRecordLite
+
+Lightweight ActiveRecord extension for basic reads and caching.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_lite'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_lite
+
+## Usage
+
+To start using lite models, inject `has_lite` in your model and append `.to_lite` to your `ActiveRecord` `scope` or `chained` method calls.
+
+```ruby
+    class User < ActiveRecord::Base
+        has_lite
+    end
+
+    @user = User.where(id: 1).to_lite # <User::ActiveRecordLite... >
+    @user.id # => 1
+    @user.name # => "name"
+
+    @users = User.where(tenant_id: 1).to_lite # [<User::ActiveRecordLite... >, ...]
+    @users.first.id # => 1
+    @users[-1].id # => 100
+```
+
+By default the lite class will include all columns defined in the parent model class. To limit to specific columns, pass the columns key to the `has_lite` call.
+
+```ruby
+    class User < ActiveRecord::Base
+        has_lite, columns: %w(id name)
+    end
+
+    @user = User.where(id: 1).to_lite
+    @user.id # => 1
+    @user.name # => "name"
+
+    @user.email # => undefined method
+```
+
+#### NOTE:
+1. To keep the gem lightweight, `serialization` is the implementer's job. Eg.
+```ruby
+    class User < ActiveRecord::Base
+        has_lite, columns: %w(id name preferences)
+
+        serialize :preferences, Hash
+    end
+    
+    # to serialize preferences in lite model
+    class User::ActiveRecordLite < ActiveRecordLite::Base
+        def preferences
+            YAML.load(read_attribute('preferences'.freeze))
+        end
+    end
+```
+2. active_record_lite internally uses active_record, hence model level default scopes will apply when querying for the record from db.
+
+3. `Boolean` columns in rails are very smaller integers - literally, `TINYINT`. Internally, `ActiveRecord` magic typecasts them to behave like bools and adds the `column_name?` methods to the model. This is also left to the implementer.
+```ruby
+    class Company::ActiveRecordLite < ActiveRecordLite::Base
+        def active
+            read_attribute('active'.freeze) == 1
+        end
+        alias :active? :active
+    end
+```
+#### TODO:
+1. Dynamic selects are not possible currently.
+
+## Development
+
+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/ritikesh/active_record_lite. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveRecordLite project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_record_lite/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+task default: :spec

data/active_record_lite.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record_lite/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_lite"
+  spec.version       = ActiveRecordLite::VERSION
+  spec.authors       = ["Ritikesh"]
+  spec.email         = ["ritikeshsisodiya@gmail.com"]
+
+  spec.summary       = %q{Light AR extension for basic reads/caching.}
+  spec.description   = %q{Lightweight extension for ActiveRecord that is useful for basic reads, caching etc.}
+  spec.homepage      = "https://github.com/ritikesh/active_record_lite"
+  spec.license       = "MIT"
+
+  spec.files         = Dir["lib/**/*", "LICENSE.txt", "Rakefile", "README.md"]
+
+  # 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"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/ritikesh/active_record_lite"
+    # spec.metadata["changelog_uri"] = "https://github.com/ritikesh/active_record_lite"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "rails", "~> 4.2"
+end

data/lib/active_record_lite.rb

@@ -0,0 +1,7 @@
+require "active_record_lite/base"
+require "active_record_lite/core_ext"
+require "active_record_lite/railtie"
+
+module ActiveRecordLite
+  # Your code goes here...
+end

data/lib/active_record_lite/base.rb

@@ -0,0 +1,42 @@
+module ActiveRecordLite
+    class Base
+        def self.columns
+            columns = base_class.instance_variable_get(:@_arlcolumns) || base_class.column_names
+            # must return this.
+            columns.each_with_index { |column, index|
+                @attr_lookup[column] = index
+            }
+        end
+
+        def self.perform(sql)
+            res = fetch_from_db(sql).map { |obj|
+                new(obj)
+            }
+            res.size > 1 ? res : res.first
+        end
+        
+        def initialize(obj)
+            @attributes = obj
+        end
+        
+        private
+        
+        attr_accessor :attributes
+        
+        def self.fetch_from_db(sql)
+            base_class.connection.execute(sql)
+        end
+        
+        def read_attribute(attr_name)
+            attributes[self.class.attr_lookup(attr_name)]
+        end
+
+        def self.attr_lookup(attr_name)
+            @attr_lookup[attr_name]
+        end
+
+        def self.base_class
+            @base_class
+        end
+    end
+end

data/lib/active_record_lite/core_ext.rb

@@ -0,0 +1,26 @@
+module ActiveRecordLite
+    module CoreExt
+        def has_lite(options={})
+            if options.key?(:columns)
+                @_arlcolumns = options.delete(:columns)
+            end
+
+            class_eval <<-EOV
+                def self.to_lite
+                    scoper = select(@_arlcolumns)
+                    ActiveRecordLite.perform(scoper.to_sql)
+                end
+                
+                class ActiveRecordLite < ActiveRecordLite::Base
+                    @base_class = parent
+                    @attr_lookup = {}
+                    columns.each do |column_name|
+                        define_method(column_name) do
+                            read_attribute(column_name)
+                        end
+                    end
+                end
+            EOV
+        end
+    end
+end

data/lib/active_record_lite/railtie.rb

@@ -0,0 +1,8 @@
+module ActiveRecordLite
+    class Railtie < Rails::Railtie
+    
+        initializer "active_record_lite.config_hook" do
+            ActiveRecord::Base.extend(ActiveRecordLite::CoreExt)
+        end
+    end
+end

data/lib/active_record_lite/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordLite
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: active_record_lite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ritikesh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Lightweight extension for ActiveRecord that is useful for basic reads,
+  caching etc.
+email:
+- ritikeshsisodiya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_lite.gemspec
+- lib/active_record_lite.rb
+- lib/active_record_lite/base.rb
+- lib/active_record_lite/core_ext.rb
+- lib/active_record_lite/railtie.rb
+- lib/active_record_lite/version.rb
+homepage: https://github.com/ritikesh/active_record_lite
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ritikesh/active_record_lite
+  source_code_uri: https://github.com/ritikesh/active_record_lite
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Light AR extension for basic reads/caching.
+test_files: []