This gem allows you to create viewings in a notebook, and store notes && images in those viewings.
Add this line to your application's Gemfile:
gem 'ViewingNotebook'And then execute:
$ bundle
Or install it yourself as:
$ gem install ViewingNotebook
To interface with the gem, use "ViewingNotebook.(method_call)" to access implemented functionality. It is strongly suggested that you communicate with the app purely through the methods defined in ViewingNotebook.rb. An example is provided below.
Adding a note: ViewingNotebook.add_viewing('Address goes here')
Also, if you're going to try to persist this ViewingNotebook in a database, make sure to mimic the interface of the in_memory repository.
To change the repository from the in_memory repository used in this gem to say, ActiveRecord, add the following code to your application.
ViewingNoteBook.configure do |config| config.repo = NameOfYourRepository::ActiveRecord end
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/Tylerwbrown/ViewingNotebookGem.