From 4bf5928def947d52a9ee2626f7660040e9a8926b Mon Sep 17 00:00:00 2001 From: Guillaume Dott Date: Wed, 8 Mar 2023 15:17:55 +0100 Subject: [PATCH] Add usage informations in README --- README.md | 31 +++++++++++++---------- sig/validates_associated_with_context.rbs | 4 --- 2 files changed, 18 insertions(+), 17 deletions(-) delete mode 100644 sig/validates_associated_with_context.rbs diff --git a/README.md b/README.md index 7f470db..fa352f9 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,33 @@ # ValidatesAssociatedWithContext -TODO: Delete this and the text below, and describe your gem - -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/validates_associated_with_context`. To experiment with that code, run `bin/console` for an interactive prompt. +Adds `validates_associated_with_context` to models to validate associated models with validation context. ## Installation -TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org. -Install the gem and add to the application's Gemfile by executing: +Add it to your Gemfile: - $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG +```ruby +gem 'validates_associated_with_context' +``` -If bundler is not being used to manage dependencies, install the gem by executing: +Run the following command to install it: - $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG +``` +bundle install +``` ## Usage -TODO: Write usage instructions here +Use `validates_associated_with_context` in your models: +```ruby +class Book < ActiveRecord::Base + has_many :pages + belongs_to :library + + validates_associated_with_context :pages, :library, context: :custom_validation_context +end +``` ## Development @@ -26,10 +35,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run 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 the created tag, 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]/validates_associated_with_context. - ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/sig/validates_associated_with_context.rbs b/sig/validates_associated_with_context.rbs deleted file mode 100644 index 9473c64..0000000 --- a/sig/validates_associated_with_context.rbs +++ /dev/null @@ -1,4 +0,0 @@ -module ValidatesAssociatedWithContext - VERSION: String - # See the writing guide of rbs: https://github.com/ruby/rbs#guides -end