RadCoreRails

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/rad_core_rails. 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:

gem 'rad_core_rails'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rad_core_rails

Usage

For basic functionality just include RadCoreRails to your ActiveRecord model.

class Job < ActiveRecord::Base
  include RadCoreRails
  ...
end

For using Zip Codes by Radius filter follow the steps below:

Step 1 - generate migration:

```shell script rails generate rad_core_rails:zip_codes_migration

Step 2 - migrate DB:

```shell script
rails db:migrate

Step 3 - import all US zip-codes to your DB:

this gem has built in JSON file with all US zip-codes

```shell script rails rad_core_rails:import_zip_codes

Step 4 - add new filter to `filter_manifest` method like on example:

> OLD Syntax
```ruby
class Job < ActiveRecord::Base
  include RadCoreRails

  def self.filter_manifest
    { 
      zip_codes: ->(filter) { generate_zip_codes_clauses('addresses.zip', filter) } 
    }.with_indifferent_access
  end
end

NEW Syntax starting from v0.7.0

class Job < ActiveRecord::Base
  include RadCoreRails

  filterable zip_codes: [:zip_codes, 'addresses.zip']
end

Step 5 - filter params example

{ key: 'zip_codes', option: '15', values: ['85001'] }

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.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rad_core_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the RadCoreRails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.