notifly 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77982bba3899b260f37bc98c4a95a56658bef69c
-  data.tar.gz: 8645e6bae431b62fa69743e026687984da53528a
+  metadata.gz: f996931a421a9e3f41a90c06d19e1c62146cc95f
+  data.tar.gz: 4348ce9aa6cb421b98ea1c4772ac7bc25dbd5fdf
 SHA512:
-  metadata.gz: 6b416b97f187382029ea72e5121a4d980872a50b6c3b1a1fb505904efdcb135e74e0231f2f9b99a49da15f4ff314cd779bdd3a766cf508b26a0f02ce5ecf8e56
-  data.tar.gz: eac2d4e0026728c73b91e74a05c7bb9bdd49f89d8c10466acf27b65194425d98283b92d50f7756d51a55450e3998d1a2e06e6e1b7d6c78b0a66b262efe0fe084
+  metadata.gz: 53ce370a1d97528f71306cc4d7dc4d441b6bbaba751f55f72b43279ed02f6a5413d1aec256ef951e3281a8ef6f0d3fba871d1f6fd8264219ef2e147f21753638
+  data.tar.gz: 19fcf140d70b9f00e633fc0b74188918ca1107dbd8d957c4f204a84f99a634483a334a6991d4671d67ef916861a2e577fc93d3f361c8a32977532a05ee681cce

data/.editorconfig

@@ -0,0 +1,22 @@
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[Rakefile]
+indent_style = space
+indent_size = 2
+
+[Gemfile*]
+indent_style = space
+indent_size = 2
+
+[config.ru]
+indent_style = space
+indent_size = 2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+before_script:
+  - cp spec/dummy/config/database.travis.yml spec/dummy/config/database.yml
+  - psql -c 'create database travis_ci_test;' -U postgres
+  - bundle install
+  - bundle exec rake db:migrate
+
+rvm:
+  - 2.0.0
+  - 2.1
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4'
+gem 'jquery-rails', ['>= 3.0', '< 5']
+gem 'kaminari', '~> 0.16.1'
+gem 'font-awesome-rails', '~> 4.2.0'
+
+group :development, :test do
+  gem 'pg'
+  gem 'rspec-rails', '~> 3.1.0'
+  gem 'capybara', '~> 2.4.4'
+  gem 'poltergeist', '~> 1.5.1'
+  gem 'shoulda-matchers', '~> 2.7.0'
+  gem 'pry-rails'
+  gem 'pry-rescue'
+  gem 'awesome_print'
+  gem 'launchy'
+end
+
+group :development do
+  gem 'better_errors'
+  gem 'binding_of_caller'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,199 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.8)
+      actionpack (= 4.1.8)
+      actionview (= 4.1.8)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.8)
+      actionview (= 4.1.8)
+      activesupport (= 4.1.8)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.8)
+      activesupport (= 4.1.8)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.8)
+      activesupport (= 4.1.8)
+      builder (~> 3.1)
+    activerecord (4.1.8)
+      activemodel (= 4.1.8)
+      activesupport (= 4.1.8)
+      arel (~> 5.0.0)
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    arel (5.0.1.20140414130214)
+    awesome_print (1.2.0)
+    better_errors (2.0.0)
+      coderay (>= 1.0.0)
+      erubis (>= 2.6.6)
+      rack (>= 0.9.0)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.2)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    cliver (0.3.2)
+    coderay (1.1.0)
+    debug_inspector (0.0.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    font-awesome-rails (4.2.0.0)
+      railties (>= 3.2, < 5.0)
+    git (1.2.8)
+    github_api (0.12.1)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.1)
+    highline (1.6.21)
+    hike (1.2.3)
+    i18n (0.6.11)
+    interception (0.5)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    jquery-rails (3.1.2)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    jwt (1.0.0)
+    kaminari (0.16.1)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.4.3)
+    mini_portile (0.6.1)
+    minitest (5.4.3)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.4.1)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pg (0.17.1)
+    poltergeist (1.5.1)
+      capybara (~> 2.1)
+      cliver (~> 0.3.1)
+      multi_json (~> 1.0)
+      websocket-driver (>= 0.2.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-rails (0.3.2)
+      pry (>= 0.9.10)
+    pry-rescue (1.4.1)
+      interception (>= 0.5)
+      pry
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.8)
+      actionmailer (= 4.1.8)
+      actionpack (= 4.1.8)
+      actionview (= 4.1.8)
+      activemodel (= 4.1.8)
+      activerecord (= 4.1.8)
+      activesupport (= 4.1.8)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.8)
+      sprockets-rails (~> 2.0)
+    railties (4.1.8)
+      actionpack (= 4.1.8)
+      activesupport (= 4.1.8)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rdoc (4.1.2)
+      json (~> 1.4)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-rails (3.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    slop (3.6.0)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.4.0)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  better_errors
+  binding_of_caller
+  capybara (~> 2.4.4)
+  font-awesome-rails (~> 4.2.0)
+  jeweler
+  jquery-rails (>= 3.0, < 5)
+  kaminari (~> 0.16.1)
+  launchy
+  pg
+  poltergeist (~> 1.5.1)
+  pry-rails
+  pry-rescue
+  rails (~> 4)
+  rspec-rails (~> 3.1.0)
+  shoulda-matchers (~> 2.7.0)

data/README.md

@@ -1,6 +1,10 @@
-# Notifly
+# Notifly [![Build Status](https://travis-ci.org/algorich/notifly.svg?branch=master)](https://travis-ci.org/algorich/notifly) [![Dependency Status](https://gemnasium.com/algorich/notifly.svg)](https://gemnasium.com/algorich/notifly)
+
+This project is still under development and it intend to offer a full notification
+system, back and front-end. Questions and suggestions are welcome and you can
+use the [issues list](https://github.com/algorich/notifly/issues) on Github to
+provide that feedback.
 
-This project intend to offer a full notification system, back and front-end.
 In actual version, notifications are composed by:
 
   - Receiver (**required**): the object that will receive the notification
@@ -34,6 +38,7 @@ see/change the default configs
 Notifly **need** to storage the notifications and to do it you need to run the migrations
 
 ```shell
+  $ rake notifly:install:migrations
   $ rake db:migrate
 ```
 
@@ -41,7 +46,7 @@ Notifly **need** to storage the notifications and to do it you need to run the m
 
 ## Back-end
 
-We have two ways to create notifications: 
+We have two ways to create notifications:
 
 #### 1. Using `#notifly` method in your classes (as callback)
 
@@ -81,13 +86,13 @@ Value explanation about each parameter:
 | `data`              | A method which returns a hash with usefull values to be persisted, like ticket price or whatever you want to persist. |
 
 Note that you can use the `default_values` parameter, it is specific to DRY your
-notiflies and set the values to all notiflies. If you need to overwrite some 
+notiflies and set the values to all notiflies. If you need to overwrite some
 default value, just declare it again like the `:accept_gift` notifly above.
 
 
 #### Using `#notifly!` method on your receiver object
 
-If you need to create notifications without callbacks, even in the 
+If you need to create notifications without callbacks, even in the
 controller scope.
 
 ```ruby
@@ -120,7 +125,7 @@ The receiver will be always the object which you call `#notifly!`
 
 You can access the notifications using the following methods:
 
-  - `object.notiflies` (**TODO**)
+  - `receiver_object.notiflies`
   - Querying `Notifly::Notifications`
   - Using our front-end helpers
 
@@ -193,5 +198,26 @@ Above are the elements that will loading the Notifly in your layout
   - **Toggle read**: this link will be rendered by `_actions.html.erb' in
     `_notification.html.erb`
 
+# Contributing
+
+Consider to use [zenhub](https://www.zenhub.io/), with it will know what issues
+and features are in "progress" or "to do". Also, I encourage you to use
+[git-flow](http://github.com/nvie/gitflow) and [EditorConfig](http://editorconfig.org).
+
+Fork the repository.  Then, run:
 
+```shell
+  git clone git@github.com:<username>/notifly.git
+  cd notifly
+  git branch master origin/master
+  git flow init -d
+  git flow feature start <your-feature>
+```
+
+Then, do work and commit your changes.
+
+```shell
+  git flow feature publish <your feature>
+```
 
+When done, open a pull request to your feature branch.

data/Rakefile

@@ -1,23 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
 begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
+require 'rake'
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Notifly'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name        = 'notifly'
+  gem.authors     = ['Pedro Passalini', 'Rafael Carvalho']
+  gem.email       = ['henrique.passalini@gmail.com', 'rafael@algorich.com.br']
+  gem.homepage    = 'https://github.com/algorich/notifly'
+  gem.summary     = 'A full notification system'
+  gem.description = 'This project intend to offer a full notification system, back and front-end.'
+  gem.license     = 'MIT'
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
 
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
 
+task :default => :test
 
-Bundler::GemHelper.install_tasks
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hello-foo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/notifly/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/lib/generators/notifly/install/install_generator.rb

@@ -17,6 +17,10 @@ module Notifly
       def copy_config
         template "config/initializers/notifly.rb"
       end
+
+      def remember_to_install_migrations
+        display 'Remember to install migrations: "rake notifly:install:migrations"', :red
+      end
     end
   end
 end