*** Use at your own risk!!! There are likely to be vulnerabilities in this app!!! ***

Roadmap

1. get code coverage up to 100% -> currently 48.27%

• -> controllers
• models
• helpers
• remove lib code to gems where possible
• remove unused lib code where possible
• libs
• any stragglers

2. add spec files for every method (use "spec_me" tags, 1140 and counting)
3. mutation test every method (use "heckle_me" tags, 1641 left)
4. upgrade to Ruby 1.9
5. set up Rubocop and clean up code quality
6. integration test and move vendored gems to Gemfile
7. integrate rails_best_practices and clean up code
8. fix password hashing
9. run Brakeman and fix vulnerabilities
10. integrate jshint and clean up javascript
11. rename all references from Bettermeans to Better
12. upgrade to Rails 3.0, 3.1, 3.2
13. upgrade to Ruby 2.0, 2.1
14. upgrade to Rails 4.0, 4.1, 4.2
15. begin using and extending...

Contributing

This project is long out of maintenance. I'm trying to bring it up to snuff in my spare time, but as you can see from the commit history, progress is slow. If you are interested in contributing, we are looking to add contributors to the project. All experience levels are welcome. If you're just getting started as a developer, please get in touch and I can help you get up and running. Check the dev notes below for details on the biggest area we could use help with: testing.

Pre-requisites

All you need is Docker. Development runs in containers via docker compose: the app runs in the mockdeep/better image (Ubuntu 16.04 with Ruby 1.8.7-p375, RubyGems 1.8.25, and Bundler 1.10.6 — the same image CI uses) alongside PostgreSQL 9.2. No local Ruby, Postgres, or ImageMagick installation is needed.

Note: the mockdeep/better image is built from the Dockerfile in this repo, but rebuilding it is no longer straightforward since Ubuntu 16.04's apt archives moved to old-releases.ubuntu.com. Treat the published image as the source of truth.

Getting started

First fork the repo using the link above, then:

# clone your copy:
git clone git@github.com:<your username>/better.git
cd better/

# Add this copy as upstream:
git remote add upstream https://github.com/mockdeep/better.git

# set up database config:
cp config/database.yml.example config/database.yml

# then edit config/database.yml: under the development and test groups, change
# `host: localhost` to `host: db` (the postgres container) and add
# `username: postgres`

# start the containers (dummy AWS keys and session secrets for development are
# set in docker-compose.yml):
docker compose up -d

# install gems (they go into a named volume, so this persists across
# container restarts):
docker compose exec app bundle install

# set up the development database:
docker compose exec app bundle exec rake db:create db:schema:load db:seed

# set up the test database:
docker compose exec app bundle exec rake db:test:prepare

# and run the tests:
docker compose exec app bundle exec rake spec

# if all passes, then you should be good to go. Please open an issue if you
# have any problems. You can boot up your server with:
docker compose exec app bundle exec script/server -b 0.0.0.0

# then visit http://localhost:3000

Running tests

# the whole suite:
docker compose exec app bundle exec rake spec

# a single directory or file:
docker compose exec app bundle exec spec spec/models/
docker compose exec app bundle exec spec spec/models/board/visible_predicate_spec.rb

# with code coverage (writes to coverage/index.html):
docker compose exec app bundle exec rake spec:rcov

Production

You'll need to set up the following in order to run on production. If you're deploying to Heroku you can push environment variables using heroku config:add MY_VAR=whatevs.

• A honeybadger.io API key: BETTER_HONEYBADGER_API_KEY=<your key here>
• S3 access keys:
  • S3_ACCESS_KEY_ID=<your AWS S3 access key id>
  • S3_SECRET_ACCESS_KEY=<your AWS S3 secret access key
• Sendgrid credentials:
  • SENDGRID_DOMAIN=<the domain of your app>
  • SENDGRID_PASSWORD=<your sendgrid password>
  • SENDGRID_USERNAME=<your sendgrid username>

Dev notes

We're looking to get spec and mutation coverage up to 100%. You will find methods throughout the code base tagged with spec_me, cover_me, and heckle_me. These tags represent three levels of test quality in order of increasing difficulty. Choose your difficulty level and search through the codebase for places you can help like git grep spec_me.

When the following conditions are met the tag can be removed:

spec_me

This is pretty basic. All we need is a unit test hitting the method. For the following method:

class MyClass
  attr_accessor :awesome

  def initialize
    awesome = true
  end

  def some_method
    if awesome?
      'awesome!'
    else
      'not awesome :('
    end

    def awesome?
      !!awesome
    end
  end
end

You might write a spec that looks like:

describe MyClass, '#some_method' do
  it 'returns "awesome!"' do
    MyClass.new.some_method.should == 'awesome!'
  end
end

cover_me

For code coverage you would need to expand the above test to include both branches:

describe MyClass, '#some_method' do
  context 'when awesome' do
    it 'returns "awesome!"' do
      MyClass.new.some_method.should == 'awesome!'
    end
  end

  context 'when not awesome' do
    it 'returns "not awesome :("' do
      my_instance = MyClass.new
      my_instance.awesome = false
      my_instance.some_method.should == 'not awesome :('
    end
  end
end

You can check the coverage of tests by running docker compose exec app bundle exec rake spec:rcov. It generates a coverage directory. Open coverage/index.html in your browser to view the output and find a class that still needs test coverage.

heckle_me

Heckle coverage is the hardest. Not only do you need cover the code, you need to check for various permutations within it. Heckle is a gem that performs mutations on your code and runs your tests against the mutated code. If your tests don't fail then they still need some work. Heckle lists out the changes it made that did not cause your tests to fail.

You can run heckle like this:

docker compose exec app bundle exec spec spec/models/board/visible_predicate_spec.rb --heckle Board#visible?

Known issues

Attachments doesn't work in dev environment

License and legalese

This codebase is based largely on the project Bettermeans, which was itself based on Redmine. Both Bettermeans and Redmine are open source and released under the terms of the GNU General Public License v2 (GPL). Better is also GPLv2.

All Redmine code is Copyright (C) 2006-2011 Jean-Philippe Lang

All Bettermeans code is Copyright (C) Shereef Bishay

All Better code is Copyright (C) Robert Fletcher