rails_static_record 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 412378e001a7abb62ed7fbc45b5296329448c4c4
-  data.tar.gz: db1b336cbe5fa56763a742eb86221742bafddcbb
+  metadata.gz: 60240b0ebf3743533a9112b72f859519c8712c5b
+  data.tar.gz: b901732caddbbfa2459b70c911e351f5cafbf51a
 SHA512:
-  metadata.gz: 9e5b8a56032eac3f0e265cac188d911c9ed8a65fe30d2181c1e5768b938e6e9c44f2529434d54b4b91922dfd982ec9a41ff12b67a6f7d50d30fee00d75e66cc1
-  data.tar.gz: dda4ac2ef01c1e33bfcdf022be03a8abaed51d8a0bfb2e45bbf8a2553a38779759990dfc5254b1136a1bbd707f46ed05e9bd222ba3077745a6711b2eca3b998c
+  metadata.gz: 07dd56083cb89e6349bc722e3416e9fd328d98fbf08e3e758c41ece280b2e11bface8fc23e9a12c28a4f30c30415023ac2b279df2e9d1ebd1faf95e817f30ff4
+  data.tar.gz: 2b28a32ae1432a8db122899b79a3b145e47940d94cd0c192cbfcd80792f20ec4bae1db50fe7dad9927b4713db7b68761bc1daf8e3877b1ede036893164ff8ad3

data/README.md

@@ -4,6 +4,23 @@ locally, is useful for models like categories to store data
 without have to access to database. Is based on ActiveRecord
 and it permits relations with native models.
 
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'static_record'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install static_record
+```
+
 ## Usage
 You can create your own static model creating a ruby file in
 _app/models_. Remember name your model according to the rails convention.
@@ -16,6 +33,15 @@ class Category < StaticRecord::Base
 end
 ```
 
+Or if you have your model static data in a custom directory, you can select it.
+```ruby
+# app/models/category.rb
+
+class Category < StaticRecord::Base
+  file '/path/to/file.yml'
+end
+```
+
 Also you have to create the model data in *_db/static_*, the name of the YAML
 file is by default the name of the table for model. In other words, if your
 model name is category, you'll have to name your data file as categories.yml.
@@ -56,25 +82,48 @@ Category.find 4, 1
 
 ```
 
-## Installation
-Add this line to your application's Gemfile:
+Use find_by or find_by! like ActionRecord.
 
 ```ruby
-gem 'static_record'
-```
+# Find by attribute without throwing an error.
+Category.find_by name: 'Is not stored'
+# => []
+
+# Find by attribute without throwing an error.
+Category.find_by! name: 'Is not stored'
+# =>
+#  StaticRecord::RecordNotFound: Couldn't find categories like name as Is not
+#  stored
+
+# Also you can use dynamic methods.
+Category.find_by_name 'Is not stored'
+# => []
 
-And then execute:
-```bash
-$ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install static_record
+Use array methods it's possible too.
+```ruby
+Category.all
+
+Category.first
+
+Category.second
+
+Category.last
+
+Category.count
+
+# Etc...
+
 ```
 
 ## Contributing
-Contribution directions go here.
+If you want to contribute with the project, you can fork this repo and create
+a pull request with your features or fixes. The code is written using the ruby
+style guide. Read this [article](https://github.com/bbatsov/ruby-style-guide)
+before contribute to this project.
+
+Also you can follow me on Twitter [@molayab_](http://twitter.com/molayab_).
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,3 +1,4 @@
+require 'rubygems'
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,11 +15,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
-
-
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'

data/lib/{static_record.rb → rails_static_record.rb}

@@ -13,3 +13,7 @@ require 'static_record/active_record'
 # require 'static_model/comparable'
 require 'static_record/loader_file'
 require 'static_record/base'
+
+if defined?(Rails) && Rails.root
+  StaticRecord::Base.file_path = File.join(Rails.root, 'db', 'static')
+end

data/lib/static_record/base.rb

@@ -10,7 +10,7 @@ module StaticRecord
       attr_accessor :file_path
 
       def file_path
-        @file_path ||= File.join(Rails.root, 'db', 'static')
+        @file_path ||= './db/static'
       end
 
       def file(path)

data/lib/static_record/gateway_model.rb

@@ -32,6 +32,18 @@ module StaticRecord
       context
     end
 
+    def find_by!(hash)
+      context = find_by hash
+      key, value = hash.first
+
+      raise RecordNotFound.new(
+        "Couldn't find #{to_s.tableize} like #{key} as #{value}",
+        to_s.tableize,
+        'id'
+      ) if context.empty?
+      context
+    end
+
     private
 
     def records

data/lib/static_record/version.rb

@@ -1,3 +1,3 @@
 module StaticRecord
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/dummy/app/models/category.rb

@@ -1,3 +1,3 @@
 class Category < StaticRecord::Base
-  file '/Users/molayab/Developer/CrowdProject/db/static/categories.yml'
+  file "#{Rails.root}/db/static/categories.yml"
 end

data/spec/dummy/config/application.rb

@@ -3,7 +3,7 @@ require_relative 'boot'
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
-require "static_record"
+require "rails_static_record"
 
 module Dummy
   class Application < Rails::Application
@@ -12,4 +12,3 @@ module Dummy
     # -- all .rb files in that directory are automatically loaded.
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_static_record
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mateo Olaya Bernal
@@ -72,7 +72,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- lib/static_record.rb
+- lib/rails_static_record.rb
 - lib/static_record/active_record.rb
 - lib/static_record/base.rb
 - lib/static_record/errors.rb
@@ -156,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="