headcount 0.0.1 → 0.5.0

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+# Version 0.5.0 - 2012-04-06
+
+* Added timestamping
+* Removed test files from gem.

data/README.md

@@ -0,0 +1,65 @@
+# Headcount
+
+Headcount provides a simple way for you to track usage of your rails apps.  If you can write a query for it, headcount can track it for you.
+
+Headcount is released under the MIT-LICENSE.
+
+# Installation
+
+```
+gem install headcount
+```
+
+or add it to your Gemfile
+
+```
+# Gemfile
+gem 'headcount'
+```
+
+# Configuration
+
+Configure Headcount through a rails initializer.  Here's an example:
+
+```
+# config/initializers/headcount.rb
+Headcount.configure do |config|
+  config.path       = 'db/headcount.json' # default
+  config.timestamp  = ''                  # default (YYYY-MM-DD HH:MM:SS)
+  
+  # by default Headcount will use the underlying table name for the key
+  count User                          # :users key implied
+  count User.where(:active => true)   # will also use implied :users key
+  
+  # you can specify the key yourself if you'd like to override the default
+  count User.active, :as => :active_members
+end
+```
+
+The `count` method accepts any object that responds to `count` -- could be `ActiveRecord::Base`, `ActiveRecord::Relation`, or your own homegrown query object. The second argument is an options hash that currently only supports the `:as` option, which allows you to override the default key.
+
+If you'd like to access or reconfigure Headcount outside of the initializer you can access the configuration object via
+`Headcount.settings`.
+
+# Usage
+
+Fire up `rails c` and run:
+```
+Headcount.count # will return current headcount as a hash
+```
+
+If you'd like to have the results written to disk instead just use the bang version:
+```
+Headcount.count! # will append the results to the output file
+```
+
+## Scheduling
+
+Your options are open as far as scheduling goes.  If you like [crontab](http://crontab.org/), use crontab. If you prefer [clockwork](https://github.com/tomykaira/clockwork), use clockwork. 
+
+You have two options for triggering a headcount.
+
+1. Call `Headcount.count!` directly
+2. Use `rake headcount`
+
+In the future I may write a daemon to simplify the scheduling process with an upstart script to boot, but for now you're on your own.

data/lib/headcount.rb

@@ -23,6 +23,8 @@ module Headcount
         count_for(key)
       else
         {}.tap do |headcount|
+          headcount[:timestamp] = Headcount::Support.timestamp_for(DateTime.now)
+          
           @@registry.each do |key, query| # using map would return an array here
             headcount[key] = query.count
           end
@@ -36,7 +38,7 @@ module Headcount
     
     def reset
       reset_registry
-      reset_configuration
+      reset_settings
     end
     
     private

data/lib/headcount/configuration.rb

@@ -2,10 +2,12 @@ module Headcount
   @@config = nil
   
   class << self
-    def configure(&block)
+    def settings
       @@config ||= Configuration::Base.new
-      @@config.evaluate(&block) if block_given?
-      @@config
+    end
+    
+    def configure(&block)
+      settings.evaluate(&block)
     end
     
     private
@@ -14,17 +16,18 @@ module Headcount
       Headcount::Persistence::File.new(@@config.path, :json)
     end
     
-    def reset_configuration
+    def reset_settings
       @@config = nil
     end
   end
   
   module Configuration
     class Base
-      attr_accessor :path
+      attr_accessor :path, :timestamp
       
       def initialize
-        @path = 'db/headcount.json'
+        @path       = 'db/headcount.json'
+        @timestamp  = '%Y-%m-%d %H:%M:%S'
       end
       
       def evaluate(&block)

data/lib/headcount/support.rb

@@ -3,6 +3,10 @@ require 'headcount/exceptions'
 module Headcount
   module Support
     class << self
+      def timestamp_for(time)
+        time.strftime(Headcount.settings.timestamp)
+      end
+      
       def key_for(query, path = [])
         key = lookup_key(query)
         
@@ -15,12 +19,20 @@ module Headcount
       
       private
       def lookup_key(query)
-        if query < ActiveRecord::Base
-          query.table_name
-        elsif query.is_a?(ActiveRecord::Relation)
-          query.table.name
+        key = nil
+        
+        if query
+          if query < ActiveRecord::Base
+            key = query.table_name
+          elsif query.is_a?(ActiveRecord::Relation)
+            key = query.table.name
+          end
+        end
+        
+        if key
+          key.to_sym
         else
-          raise ArgumentError, "Unable to imply key. Please provide one via :as."
+          raise Headcount::UnsupportedQuery, "Unable to imply key. Please provide one via :as."
         end
       end
     end

data/lib/headcount/version.rb

@@ -1,3 +1,3 @@
 module Headcount
-  VERSION = "0.0.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -2,7 +2,7 @@
 name: headcount
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.5.0
 platform: ruby
 authors: 
 - Ryan Mohr
@@ -99,7 +99,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/headcount/api.rb
 - lib/headcount/configuration.rb
 - lib/headcount/exceptions.rb
 - lib/headcount/persistence/file.rb
@@ -115,48 +114,8 @@ files:
 - Gemfile
 - Gemfile.lock
 - Rakefile
-- README.rdoc
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/headcount.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config.ru
-- spec/dummy/db/development.sqlite3
-- spec/dummy/db/migrate/20120406005419_add_users.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/Rakefile
-- spec/dummy/README.rdoc
-- spec/dummy/script/rails
-- spec/models/api_spec.rb
-- spec/models/configuration_spec.rb
-- spec/models/persistence_spec.rb
-- spec/spec_helper.rb
-- spec/tmp/headcount.json
+- README.md
+- CHANGELOG.md
 homepage: http://github.com/kumu/headcount
 licenses: []
 
@@ -184,45 +143,5 @@ rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: A simple stat collector for rails apps
-test_files: 
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/headcount.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config.ru
-- spec/dummy/db/development.sqlite3
-- spec/dummy/db/migrate/20120406005419_add_users.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/Rakefile
-- spec/dummy/README.rdoc
-- spec/dummy/script/rails
-- spec/models/api_spec.rb
-- spec/models/configuration_spec.rb
-- spec/models/persistence_spec.rb
-- spec/spec_helper.rb
-- spec/tmp/headcount.json
+test_files: []
+

data/README.rdoc

@@ -1,3 +0,0 @@
-= Headcount
-
-This project rocks and uses MIT-LICENSE.

data/lib/headcount/api.rb

@@ -1,11 +0,0 @@
-require 'headcount/registry'
-
-module Headcount
-  module API
-    extend ActiveSupport::Concern
-    
-    module ClassMethods
-      
-    end
-  end
-end

data/spec/dummy/README.rdoc

@@ -1,261 +0,0 @@
-== Welcome to Rails
-
-Rails is a web-application framework that includes everything needed to create
-database-backed web applications according to the Model-View-Control pattern.
-
-This pattern splits the view (also called the presentation) into "dumb"
-templates that are primarily responsible for inserting pre-built data in between
-HTML tags. The model contains the "smart" domain objects (such as Account,
-Product, Person, Post) that holds all the business logic and knows how to
-persist themselves to a database. The controller handles the incoming requests
-(such as Save New Account, Update Product, Show Post) by manipulating the model
-and directing data to the view.
-
-In Rails, the model is handled by what's called an object-relational mapping
-layer entitled Active Record. This layer allows you to present the data from
-database rows as objects and embellish these data objects with business logic
-methods. You can read more about Active Record in
-link:files/vendor/rails/activerecord/README.html.
-
-The controller and view are handled by the Action Pack, which handles both
-layers by its two parts: Action View and Action Controller. These two layers
-are bundled in a single package due to their heavy interdependence. This is
-unlike the relationship between the Active Record and Action Pack that is much
-more separate. Each of these packages can be used independently outside of
-Rails. You can read more about Action Pack in
-link:files/vendor/rails/actionpack/README.html.
-
-
-== Getting Started
-
-1. At the command prompt, create a new Rails application:
-       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
-
-2. Change directory to <tt>myapp</tt> and start the web server:
-       <tt>cd myapp; rails server</tt> (run with --help for options)
-
-3. Go to http://localhost:3000/ and you'll see:
-       "Welcome aboard: You're riding Ruby on Rails!"
-
-4. Follow the guidelines to start developing your application. You can find
-the following resources handy:
-
-* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
-* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
-
-
-== Debugging Rails
-
-Sometimes your application goes wrong. Fortunately there are a lot of tools that
-will help you debug it and get it back on the rails.
-
-First area to check is the application log files. Have "tail -f" commands
-running on the server.log and development.log. Rails will automatically display
-debugging and runtime information to these files. Debugging info will also be
-shown in the browser on requests from 127.0.0.1.
-
-You can also log your own messages directly into the log file from your code
-using the Ruby logger class from inside your controllers. Example:
-
-  class WeblogController < ActionController::Base
-    def destroy
-      @weblog = Weblog.find(params[:id])
-      @weblog.destroy
-      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
-    end
-  end
-
-The result will be a message in your log file along the lines of:
-
-  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
-
-More information on how to use the logger is at http://www.ruby-doc.org/core/
-
-Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
-several books available online as well:
-
-* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
-* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
-
-These two books will bring you up to speed on the Ruby language and also on
-programming in general.
-
-
-== Debugger
-
-Debugger support is available through the debugger command when you start your
-Mongrel or WEBrick server with --debugger. This means that you can break out of
-execution at any point in the code, investigate and change the model, and then,
-resume execution! You need to install ruby-debug to run the server in debugging
-mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
-
-  class WeblogController < ActionController::Base
-    def index
-      @posts = Post.all
-      debugger
-    end
-  end
-
-So the controller will accept the action, run the first line, then present you
-with a IRB prompt in the server window. Here you can do things like:
-
-  >> @posts.inspect
-  => "[#<Post:0x14a6be8
-          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
-       #<Post:0x14a6620
-          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
-  >> @posts.first.title = "hello from a debugger"
-  => "hello from a debugger"
-
-...and even better, you can examine how your runtime objects actually work:
-
-  >> f = @posts.first
-  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
-  >> f.
-  Display all 152 possibilities? (y or n)
-
-Finally, when you're ready to resume execution, you can enter "cont".
-
-
-== Console
-
-The console is a Ruby shell, which allows you to interact with your
-application's domain model. Here you'll have all parts of the application
-configured, just like it is when the application is running. You can inspect
-domain models, change values, and save to the database. Starting the script
-without arguments will launch it in the development environment.
-
-To start the console, run <tt>rails console</tt> from the application
-directory.
-
-Options:
-
-* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
-  made to the database.
-* Passing an environment name as an argument will load the corresponding
-  environment. Example: <tt>rails console production</tt>.
-
-To reload your controllers and models after launching the console run
-<tt>reload!</tt>
-
-More information about irb can be found at:
-link:http://www.rubycentral.org/pickaxe/irb.html
-
-
-== dbconsole
-
-You can go to the command line of your database directly through <tt>rails
-dbconsole</tt>. You would be connected to the database with the credentials
-defined in database.yml. Starting the script without arguments will connect you
-to the development database. Passing an argument will connect you to a different
-database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
-PostgreSQL and SQLite 3.
-
-== Description of Contents
-
-The default directory structure of a generated Ruby on Rails application:
-
-  |-- app
-  |   |-- assets
-  |       |-- images
-  |       |-- javascripts
-  |       `-- stylesheets
-  |   |-- controllers
-  |   |-- helpers
-  |   |-- mailers
-  |   |-- models
-  |   `-- views
-  |       `-- layouts
-  |-- config
-  |   |-- environments
-  |   |-- initializers
-  |   `-- locales
-  |-- db
-  |-- doc
-  |-- lib
-  |   `-- tasks
-  |-- log
-  |-- public
-  |-- script
-  |-- test
-  |   |-- fixtures
-  |   |-- functional
-  |   |-- integration
-  |   |-- performance
-  |   `-- unit
-  |-- tmp
-  |   |-- cache
-  |   |-- pids
-  |   |-- sessions
-  |   `-- sockets
-  `-- vendor
-      |-- assets
-          `-- stylesheets
-      `-- plugins
-
-app
-  Holds all the code that's specific to this particular application.
-
-app/assets
-  Contains subdirectories for images, stylesheets, and JavaScript files.
-
-app/controllers
-  Holds controllers that should be named like weblogs_controller.rb for
-  automated URL mapping. All controllers should descend from
-  ApplicationController which itself descends from ActionController::Base.
-
-app/models
-  Holds models that should be named like post.rb. Models descend from
-  ActiveRecord::Base by default.
-
-app/views
-  Holds the template files for the view that should be named like
-  weblogs/index.html.erb for the WeblogsController#index action. All views use
-  eRuby syntax by default.
-
-app/views/layouts
-  Holds the template files for layouts to be used with views. This models the
-  common header/footer method of wrapping views. In your views, define a layout
-  using the <tt>layout :default</tt> and create a file named default.html.erb.
-  Inside default.html.erb, call <% yield %> to render the view using this
-  layout.
-
-app/helpers
-  Holds view helpers that should be named like weblogs_helper.rb. These are
-  generated for you automatically when using generators for controllers.
-  Helpers can be used to wrap functionality for your views into methods.
-
-config
-  Configuration files for the Rails environment, the routing map, the database,
-  and other dependencies.
-
-db
-  Contains the database schema in schema.rb. db/migrate contains all the
-  sequence of Migrations for your schema.
-
-doc
-  This directory is where your application documentation will be stored when
-  generated using <tt>rake doc:app</tt>
-
-lib
-  Application specific libraries. Basically, any kind of custom code that
-  doesn't belong under controllers, models, or helpers. This directory is in
-  the load path.
-
-public
-  The directory available for the web server. Also contains the dispatchers and the
-  default HTML files. This should be set as the DOCUMENT_ROOT of your web
-  server.
-
-script
-  Helper scripts for automation and generation.
-
-test
-  Unit and functional tests along with fixtures. When using the rails generate
-  command, template test files will be generated for you and placed in this
-  directory.
-
-vendor
-  External libraries that the application depends on. Also includes the plugins
-  subdirectory. If the app has frozen rails, those gems also go here, under
-  vendor/rails/. This directory is in the load path.