morning-pages 0.2.2 → 1.0.0

data/README.md

@@ -5,15 +5,22 @@ Morning Pages
 
 I've long been fascinated by the morning pages habit of writing three pages (or about 750 words) of whatever comes into your head each day - it's like taking a mental showers and helps to clear your head, ready for the day. There are great sites out there like http://750words.com, but I live on the command line and like to keep my words on my own computer.
 
-When installed, type `morning-pages help` for more info.
+When installed, type `morning-pages` to open your `$EDITOR` with the file for today. Type away and quit your editor, and you'll get stats on how many words you've typed today.
+
+Use `-d <folder>` to change the default words folder (currently `~/words`).
+
+## Plans
+
+In future, I hope to post words stats up to a central server so we can track leaderboards and badges. Don't worry, we'll never post your actual words.
 
 ## Contributing
 
 We work on pull requests. If you have an idea for something you'd like to contribute, here's how to do it:
 
-1. Create a local branch, and commit a failing spec that describes what you want to implement.
-2. Push the branch, go on Github and create a pull request from the head of the branch.
-3. Start the conversation: ping the mailing list and get some people to pair with you on designing the code. Iterate in the pull request, adding more specs, making them pass and refactoring until everyone is happy.
-4. Remember to regularly rebase your branch from master in case there are upstream changes to pull in.
-5. Get someone else to merge your pull request, that way you know your code makes sense to at least one other person.
-6. Go and have a nice cup of tea to celebrate.
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/bin/morning-pages

@@ -3,16 +3,47 @@ $: << File.dirname(__FILE__) + '/../lib'
 
 require 'trollop'
 require 'morning-pages'
+require 'highline/import'
 
 opts = Trollop.options do
   opt :dir, "Words directory", :required => false, :type => :string, :default => "~/words"
+  opt :config, "Configuration file", :required => false, :type => :string, :default => "~/.morning-pages/config.yml"
+  opt :server, "Stats server", :required => false, :type => :string, :default => "http://morning-pages.me/api"
 end
 
-opts[:dir] = File.expand_path(opts[:dir])
-MorningPages.setup(opts)
+[:dir, :config].each { |key| opts[key] = File.expand_path(opts[key]) }
 
-path = MorningPages.today_path(opts[:dir])
+config = MorningPages::Config.new(opts[:config], opts[:server])
+unless (config.registered?)
+  say "<%= color('Welcome to Morning Pages!', :yellow) %>"
+  say "We record basic stats and the fact you've posted under your chosen username at http://morning-pages.me"
+  say "We never post your actual words or your real name."
+  username = ask "What is your desired username? " do |q|
+    q.validate = /\w+/
+  end
+  email = ask "What is your email address (for account recovery?) " do |q|
+    q.validate = /@/
+  end
+  if config.register!(:username => username, :email => email)
+    say "Saved to #{opts[:config]}."
+  else
+    say "<%= color('There was a problem registering your account.', :red) %> You can continue but your stats will not be saved to the website."
+    if (ask "Press enter to continue, or 'q' and then enter to quit:") == 'q'
+      exit(0)
+    end
+  end
+end
+
+pages = MorningPages::Folder.new(opts)
+
+path = pages.today_path
 
 system "$EDITOR #{path}"
 
-puts MorningPages.stats_for_today(opts[:dir])
+stats = MorningPages::Stats.new(pages.todays_words)
+puts MorningPages::TextReporter.new(stats).report
+if stats.post!(config)
+  say "Stats uploaded to #{opts[:server]}"
+else
+  say "<%= color('There was a problem posting your stats this time.', :red) %> You can try running the problem again to retry if you want to."
+end

data/features/step_definitions/steps.rb

@@ -1,7 +1,33 @@
 require 'tmpdir'
+require 'background_process'
+
+def prep_config
+  yaml = "---\n:username: test\n:email: test@example.com\n"
+  File.open(@config, 'w') { |f| f.write(yaml) }
+end
+
+def command
+  "morning-pages -d #{@dir} -c #{@config} -s http://localhost:45110/api"
+end
 
 When /^I run 'morning\-pages'$/ do
-  run "morning-pages -d #{@dir}"
+  prep_config
+  run command
+end
+
+When /^I run 'morning\-pages' for the first time$/ do
+  run_interactive command
+  type("chrismdp")
+  type("chris@example.com")
+end
+
+Then /^I should be asked for my username and email before writing$/ do
+  all_output.should match(/username/i)
+  all_output.should match(/email/i)
+end
+
+Then /^I should have my stats uploaded to the website after writing$/ do
+  all_output.should match(/uploaded/i)
 end
 
 Then /^I should be able to write my words$/ do
@@ -9,14 +35,27 @@ Then /^I should be able to write my words$/ do
   check_exact_file_content "#{@dir}/#{Time.now.strftime("%Y\-%m\-%d")}", "fake editor output"
 end
 
-Then /^I see my current word stats after I finish$/ do
+Then /^I should see my current word stats after I finish$/ do
   all_output.should match(/3 words/)
 end
 
 Before do
   @dir = Dir.mktmpdir + "/words/foo"
+  @config = Dir.mktmpdir + '/config.yml'
+  @server = BackgroundProcess.run("bundle exec rackup -p 45110 features/support/server.ru")
+  @out = []
+  @server.detect { |line| @out << line; line =~ /WEBrick::HTTPServer#start/ }
 end
 
+
 After do
-  FileUtils.remove_entry_secure @dir
+  FileUtils.remove_entry_secure @dir if File.exists?(@dir)
+  @server.kill("KILL")
+  @server.wait
+  @out << @server.stdout.read
+  @out << @server.stderr.read
+  puts "Stopped server"
+  puts "TEST SERVER OUTPUT"
+  puts @out.join
+  $stdout.flush
 end

data/features/support/env.rb

@@ -1 +1,3 @@
 $: << File.dirname(__FILE__) + '/../../lib'
+
+require 'webmock/cucumber'

data/features/support/server.ru

@@ -0,0 +1,13 @@
+require 'sinatra'
+
+post '/api/register' do
+  content_type "application/json"
+  %{{"key":"12345"}}
+end
+
+post '/api/stats' do
+  halt 401 unless params[:key] == '12345'
+  "OK"
+end
+
+run Sinatra::Application

data/features/uploading_stats.feature

@@ -0,0 +1,14 @@
+Feature: Uploading stats
+  As Wilma the writer
+  I want to type morning-pages for the first time and be asked for a login, which is then checked to see if it's available
+
+  Scenario: Credential saving
+    When I run 'morning-pages' for the first time
+    Then I should be asked for my username and email before writing
+    And I should have my stats uploaded to the website after writing
+
+  Scenario: Username already taken
+    When I run 'morning-pages' for the first time
+    And I enter an existing username
+    Then I should be asked for another username
+

data/features/writing_words.feature

@@ -6,4 +6,4 @@ Feature: writing words
   Scenario:
     When I run 'morning-pages'
     Then I should be able to write my words
-    And I see my current word stats after I finish
+    And I should see my current word stats after I finish

data/lib/morning-pages.rb

@@ -1,6 +1,15 @@
 require "morning-pages/version"
+require "morning-pages/folder"
+require "morning-pages/config"
+require "morning-pages/stats"
+require "morning-pages/text_reporter"
+
 require 'fileutils'
 
+module MorningPages
+  TARGET = 750
+end
+
 class Array
   def mean
     inject(0, &:+) / count.to_f
@@ -11,28 +20,3 @@ class Array
   end
 end
 
-module MorningPages
-  def self.setup(options)
-    FileUtils.mkdir_p(options[:dir]) unless File.exists?(options[:dir])
-  end
-
-  def self.stats_for_today(dir)
-    words = get_words_for(today_path(dir)).split(" ")
-    [
-      "You have written #{words.count} words today.",
-      average_word_length(words)
-    ].join(" ")
-  end
-
-  def self.average_word_length(words)
-    words.empty? ? "" : "Average word length: %.2f" % [ words.average_length ]
-  end
-
-  def self.today_path(dir)
-    File.expand_path([dir, Time.now.strftime("%Y\-%m\-%d")].join('/'))
-  end
-
-  def self.get_words_for(path)
-    File.exists?(path) ? File.read(path) : ""
-  end
-end

data/lib/morning-pages/config.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+require 'httparty'
+
+module MorningPages
+  class Config
+    def initialize(config_path, server)
+      @config_path = config_path
+      @server = server
+      containing_folder = File.dirname(config_path)
+
+      unless (File.exists?(containing_folder))
+        FileUtils.mkdir_p(containing_folder)
+      end
+
+      @config = {}
+      if (File.exists?(@config_path))
+        @config = YAML.load(File.read(@config_path))
+      end
+    end
+
+    def registered?
+      @config.include? :username
+    end
+
+    def register!(params)
+      response = HTTParty.post("#{@server}/register", :body => params)
+      return false if response.code != 200
+      save(params.merge(:key => response.fetch("key")))
+      write!
+      true
+    rescue Timeout::Error
+      return false
+    end
+
+    def post_stats!(params)
+      response = HTTParty.post("#{@server}/stats", :body => params.merge(:key => @config[:key]))
+      return false if response.code != 200
+      true
+    rescue Timeout::Error
+      return false
+    end
+
+    private
+
+    def save(params)
+      @config.merge!(params)
+    end
+
+    def write!
+      File.open(@config_path, 'w') { |f| f.write(@config.to_yaml) }
+    end
+  end
+end

data/lib/morning-pages/folder.rb

@@ -0,0 +1,22 @@
+module MorningPages
+  class Folder
+    def initialize(options = {})
+      @dir = options[:dir]
+      if (@dir && !File.exists?(@dir))
+        FileUtils.mkdir_p(@dir)
+      end
+    end
+
+    def todays_words
+      get_words_for(today_path)
+    end
+
+    def today_path
+      File.expand_path([@dir, Time.now.strftime("%Y\-%m\-%d")].join('/'))
+    end
+
+    def get_words_for(path)
+      (File.exists?(path) ? File.read(path) : "").split(" ")
+    end
+  end
+end

data/lib/morning-pages/stats.rb

@@ -0,0 +1,15 @@
+module MorningPages
+  class Stats < Struct.new(:words)
+    def count
+      words.count
+    end
+
+    def average_length
+      words.average_length
+    end
+
+    def post!(config)
+      config.post_stats!(:count => count, :average_length => average_length)
+    end
+  end
+end

data/lib/morning-pages/text_reporter.rb

@@ -0,0 +1,23 @@
+module MorningPages
+  class TextReporter < Struct.new(:stats)
+    def report
+      [
+        target(stats),
+        "You have written #{stats.count} words today.",
+        average_word_length(stats)
+      ].join("\n")
+    end
+
+    def average_word_length(stats)
+      stats.count > 0 ?
+        "Average word length: %.2f." % [ stats.average_length ] :
+        ""
+    end
+
+    def target(stats)
+      stats.count >= MorningPages::TARGET ?
+        "Congratulations! You have reached the target today -- you are awesome!" :
+        "You have written %.2f%% of the target today." % [stats.count * 100.0 / TARGET]
+    end
+  end
+end

data/lib/morning-pages/version.rb

@@ -1,3 +1,3 @@
 module MorningPages
-  VERSION = "0.2.2"
+  VERSION = "1.0.0"
 end

data/morning-pages.gemspec

@@ -21,8 +21,13 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'trollop', '~> 1.16.2'
+  s.add_dependency 'highline'
+  s.add_dependency 'httparty'
   s.add_development_dependency 'rspec',    '~> 2.10.0'
   s.add_development_dependency 'rake',     '~> 0.9.2.2'
   s.add_development_dependency 'cucumber', '~> 1.2'
   s.add_development_dependency 'aruba',    '~> 0.4'
+  s.add_development_dependency 'webmock',    '~> 1.8.10'
+  s.add_development_dependency 'background_process',    '~> 1.3'
+  s.add_development_dependency 'sinatra'
 end

data/spec/config_spec.rb

@@ -0,0 +1,94 @@
+require 'morning-pages'
+
+require 'webmock/rspec'
+
+describe 'config' do
+  subject { MorningPages::Config.new('new-folder/file', 'http://morning-pages.me/api') }
+  let(:params) {{ :username => "test", :email => "test@example.com" }}
+  let(:yaml) { params.to_yaml }
+  before do
+    FileUtils.stub(:mkdir_p)
+  end
+  context 'not pre-existing' do
+    before do
+      File.stub(:exists? => false)
+    end
+
+    it 'creates the folder' do
+      FileUtils.should_receive(:mkdir_p).with("new-folder")
+      subject
+    end
+
+    it 'is not registered' do
+      subject.should_not be_registered
+    end
+
+    context 'saving to file' do
+      let(:file) { double }
+      before do
+        File.stub(:open).with('new-folder/file', 'w').and_yield(file)
+        file.stub(:write)
+        stub_request(:post, "http://morning-pages.me/api/register").
+          to_return(:status => 200, :body => %{{"key":"abcde"}}, :headers => { "Content-type" => "application/json"})
+      end
+
+      it 'writes the file with a key from the server' do
+        file.should_receive(:write).with(params.merge(:key => 'abcde').to_yaml)
+        subject.register!(:username => 'test', :email => 'test@example.com').should be_true
+      end
+
+      it 'returns message on timeout' do
+        stub_request(:post, "http://morning-pages.me/api/register").to_timeout
+        subject.register!(:username => 'test', :email => 'test@example.com').should be_false
+      end
+
+      it 'returns false on failed request' do
+        stub_request(:post, "http://morning-pages.me/api/register").to_return(:status => 406)
+        subject.register!(:username => 'test', :email => 'test@example.com').should be_false
+      end
+    end
+
+    context 'posting stats' do
+      it 'posts them to the website' do
+        stub_request(:post, "http://morning-pages.me/api/stats").
+          to_return(:status => 200, :body => %{OK})
+        subject.post_stats!(:count => 4, :average_length => 2.1).should be_true
+      end
+
+      it 'returns a failure if there was a problem' do
+        stub_request(:post, "http://morning-pages.me/api/stats").
+          to_return(:status => 500)
+        subject.post_stats!(:count => 4, :average_length => 2.1).should be_false
+        stub_request(:post, "http://morning-pages.me/api/stats").to_timeout
+        subject.post_stats!(:count => 4, :average_length => 2.1).should be_false
+      end
+    end
+  end
+
+  context 'with an existing folder but no file' do
+    before do
+      File.stub(:exists?).with('new-folder').and_return(true)
+      File.stub(:exists?).with('new-folder/file').and_return(false)
+    end
+
+    it 'does not create the folder' do
+      FileUtils.should_not_receive(:mkdir_p)
+      subject
+    end
+
+    it 'is not registered' do
+      subject.should_not be_registered
+    end
+  end
+
+  context 'with existing file' do
+    before do
+      File.stub(:exists? => true)
+      File.stub(:read => yaml)
+    end
+
+    it 'is registered' do
+      subject.should be_registered
+    end
+  end
+end

data/spec/setup_spec.rb

@@ -4,13 +4,13 @@ describe 'setup' do
   context 'with a new folder' do
     it 'creates the folder' do
       FileUtils.should_receive(:mkdir_p)
-      MorningPages.setup(:dir => 'new-folder')
+      MorningPages::Folder.new(:dir => 'new-folder')
     end
   end
   context 'with an existing folder' do
     it 'does nothing' do
       FileUtils.should_not_receive(:mkdir_p)
-      MorningPages.setup(:dir => '.')
+      MorningPages::Folder.new(:dir => '.')
     end
   end
 end

data/spec/stats_spec.rb

@@ -1,33 +1,58 @@
 require 'morning-pages'
 
-module MorningPages
-  describe 'stats' do
-    context 'for today' do
-      before(:each) do
-        File.stub(:exists? => true)
-        File.stub(:read => "foo ba")
-      end
+describe 'stats' do
+  let(:folder) { MorningPages::Folder.new(:dir => '/tmp/foo') }
 
-      it 'prints out the word count' do
-        MorningPages.stats_for_today("foo").should match(/2 words/)
-      end
+  before(:each) do
+    File.stub(:exists? => true)
+    File.stub(:read => "foo ba")
+  end
+
+  describe "posting" do
+    subject { MorningPages::Stats.new(folder.todays_words) }
+    let(:config) { double }
+
+    it 'posts the stats to the website using config key' do
+      config.should_receive(:post_stats!).with(:count => 2, :average_length => 2.5)
+      subject.post!(config)
+    end
+  end
+
+  context 'for today' do
+    let(:stats) { MorningPages::Stats.new(folder.todays_words) }
+    subject { MorningPages::TextReporter.new(stats) }
+
+    it 'prints out the word count' do
+      subject.report.should match(/2 words/)
+    end
+
+    it 'prints the average word length' do
+      subject.report.should match(/2\.5/)
+    end
+
+    it 'prints your percentage to go' do
+      subject.report.should match(/0.27%/)
+    end
 
-      it 'prints the average word length' do
-        MorningPages.stats_for_today("foo").should match(/2\.5/)
+    context "when written 800 words" do
+      before { File.stub(:read => "word " * 800) }
+
+      it "shows a nice message" do
+        subject.report.should match(/Congratulations.*awesome/)
       end
+    end
 
-      context 'when today has no words yet' do
-        before do
-          File.stub(:exists? => false)
-        end
+    context 'when today has no words yet' do
+      before do
+        File.stub(:exists? => false)
+      end
 
-        it "shows a message to that effect" do
-          MorningPages.stats_for_today("foo").should match(/0 words/)
-        end
+      it "shows a message to that effect" do
+        subject.report.should match(/0 words/)
+      end
 
-        it "does not show average" do
-          MorningPages.stats_for_today("foo").should_not match(/NaN/)
-        end
+      it "does not show average" do
+        subject.report.should_not match(/NaN/)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: morning-pages
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -27,6 +27,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.16.2
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +123,54 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.10
+- !ruby/object:Gem::Dependency
+  name: background_process
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "I've long been fascinated by the morning pages habit of writing three
   pages (or about 750 words) of whatever comes into your head each day - it's like
   taking a mental showers and helps to clear your head, ready for the day. There are
@@ -104,6 +184,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .DS_Store
 - .gitignore
 - .rspec
 - Gemfile
@@ -114,10 +195,17 @@ files:
 - features/step_definitions/steps.rb
 - features/support/driver.rb
 - features/support/env.rb
+- features/support/server.ru
+- features/uploading_stats.feature
 - features/writing_words.feature
 - lib/morning-pages.rb
+- lib/morning-pages/config.rb
+- lib/morning-pages/folder.rb
+- lib/morning-pages/stats.rb
+- lib/morning-pages/text_reporter.rb
 - lib/morning-pages/version.rb
 - morning-pages.gemspec
+- spec/config_spec.rb
 - spec/setup_spec.rb
 - spec/stats_spec.rb
 homepage: http://github.com/chrismdp/morning-pages
@@ -132,15 +220,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -965781968581789806
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -965781968581789806
 requirements: []
 rubyforge_project: morning-pages
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Command line helper to write your morning pages
@@ -149,6 +243,9 @@ test_files:
 - features/step_definitions/steps.rb
 - features/support/driver.rb
 - features/support/env.rb
+- features/support/server.ru
+- features/uploading_stats.feature
 - features/writing_words.feature
+- spec/config_spec.rb
 - spec/setup_spec.rb
 - spec/stats_spec.rb