TextTractor 0.1.0

data/text_tractor.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "text_tractor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "TextTractor"
+  s.version     = TextTractor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jon Wood"]
+  s.email       = ["jon@blankpad.net"]
+  s.homepage    = "https://github.com/jellybob/text_tractor"
+  s.summary     = %q{An implementation of the server side for a certain web service.}
+  s.description = %q{TextTractor provides a web interface so that your clients can edit their copy, while you get on with more interesting things.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "haml"
+  s.add_dependency "sass"
+  s.add_dependency "sinatra"
+  s.add_dependency "json"
+  s.add_dependency "redis"
+  s.add_dependency "redis-namespace"
+  
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rack-test"
+  s.add_development_dependency "capybara"
+
+  s.post_install_message = "If you're updating from 0.0.1 then you need to run TextTractor::Projects.update_datastore. See https://github.com/jellybob/text_tractor/wiki/Updating-Your-Datastore for details."
+end

data/views/blurbs/_blurb.haml

@@ -0,0 +1 @@
+%dd{ "data-key" => @key }= @value

data/views/blurbs/edit.haml

@@ -0,0 +1,5 @@
+%dt{ class: "state-#{@phrase[@locale].state}" }= @path.split("/").collect { |part| part.gsub("_", " ").capitalize }.join(" / ")
+%dd{ "data-key" => @path.gsub("/", ".") }
+  %form{ method: "post", action: "/projects/#{@api_key}/#{@locale}/#{@path}" }
+    %textarea{ name: "blurb" }= @phrase[@locale].to_s.strip
+    %input{ type: "submit", value: "Save" }

data/views/blurbs/value.haml

@@ -0,0 +1,9 @@
+%dt{ class: "state-#{phrase.state}" }= key.split(".").collect { |part| part.gsub("_", " ").capitalize }.join(" / ")
+%dd{ "data-key" => key }
+  - unless phrase.to_s.empty?
+    %p.translation= phrase.to_s
+  - else
+    %p.translation.empty Click to add a translation
+  
+  - if show_original
+    %p.original= original

data/views/index.haml

@@ -0,0 +1,13 @@
+%h1 Projects
+
+%section#projects
+  - if @projects.size > 0
+    %ul
+      - @projects.each do |project|
+        %li
+          %a{ href: "/projects/#{project["api_key"]}" }= project["name"]
+  - else
+    %p It doesn't look like you've got any projects yet.
+
+  - if current_user["superuser"]
+    %a#new_project{ href: "/projects/new" } Create a Project

data/views/layout.haml

@@ -0,0 +1,26 @@
+!!! 5
+%html
+  %head
+    %title TextTractor
+    %link{ rel: "stylesheet", href: "/styles.css"}
+    %script{ src: "/js/jquery.js" }
+    %script{ src: "/js/jquery.pjax.js" }
+    %script{ src: "/js/application.js" }
+
+  %body
+    %header
+      %ul#navigation
+        - if current_user["superuser"]
+          %li
+            %a{ href: "/users" } Users
+        %li 
+          %a{ href: "/" } Projects
+
+      %h1 TextTractor
+        
+    %section#content
+      =yield
+
+    %footer
+      %a{ href: "http://blankpad.net", target: "_top" }
+        %img{ src: "/images/blankpad.png", alt: "Blank Pad Development", title: "Developed by Blank Pad Development" }

data/views/projects/getting_started.haml

@@ -0,0 +1,16 @@
+%h1= "#{@project["name"]} (#{@project["default_locale"]})"
+%p It doesn't look like you've set up your application to work with TextTractor yet. If you know what you're doing your API key is:
+%p.api_key= @project["api_key"]
+
+%p Otherwise, follow the instructions below to configure a Rails 3 application:
+
+%p Add Copycopter client to your Gemfile
+%code gem "copycopter_client"
+
+%p Then create config/initializers/text_tractor.rb with the following content:
+%code= @project.configuration_block
+
+%p And finally, restart your application server. Your appliction will then upload translations and this page will disappear.
+%p 
+  As you open each page you'll see the translations defined on those pages appear here. Any changes you make from this web interface
+  will appear within your development and staging applications shortly afterwards.

data/views/projects/new.haml

@@ -0,0 +1,18 @@
+%h1 New Project
+%form{ action: "/projects", method: "post" }
+  %div.field
+    %label{ for: "name" } Project Name
+    %input{ type: "text", name: "project[name]", id: "name" }
+  
+  %div.field
+    %label{ for: "default_locale" } Default Locale
+    %input{ type: "text", name: "project[default_locale]", id: "default_locale", value: "en" }
+
+  %h2 Users
+  %p Check the box next to each user who should be granted access to this project.
+  - @users.each do |user|
+    %div.field
+      %label{ for: "user_#{user["username"]}" }= user["name"]
+      %input{ type: "checkbox", name: "project[users][]", id: "user_#{user["username"]}" }
+
+  %input{ type: "submit", value: "Create Project" }

data/views/projects/show.haml

@@ -0,0 +1,23 @@
+%h1= "#{@project["name"]} (#{@locale})"
+%ul#locales
+  - @project.locales.each do |locale|
+    %li
+      - if locale == @locale
+        = locale
+      - else
+        %a{ href: "/projects/#{@project.api_key}/#{locale}" }= locale
+
+%form#filter{ method: "get" }
+  %label{ for: "state" } Filter:
+  %select#state{ name: "state" }
+    - { "all" => "All", "needs_work" => "Requires work", "translated" => "Translated", "untranslated" => "Untranslated", "stale" => "Stale" }.each do |key, value|
+      - if key == params["state"]
+        %option{ selected: "selected", value: key }= value
+      - else
+        %option{ value: key }= value
+
+%p Click on a phrase to edit it.
+
+%dl
+  - @phrases.sort.each do |key, value|
+    = haml :"blurbs/value", :layout => false, :locals => { :phrase => value[@locale], :key => key, :locale => @locale, :original => value[@project.default_locale], :show_original => @project.default_locale != @locale }

data/views/styles.scss

@@ -0,0 +1,218 @@
+/* Reset */
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed, 
+figure, figcaption, footer, header, hgroup, 
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	font-size: 100%;
+	font: inherit;
+	vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure, 
+footer, header, hgroup, menu, nav, section {
+	display: block;
+}
+body {
+	line-height: 1;
+}
+ol, ul {
+	list-style: none;
+}
+blockquote, q {
+	quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+	content: '';
+	content: none;
+}
+table {
+	border-collapse: collapse;
+	border-spacing: 0;
+}
+
+/* The real deal */
+body {
+  background-color: #f5f5f5;
+  font-family: "Georgia", serif;
+  padding: 0;
+  margin: 0;
+
+  header {
+    margin: 0;
+    padding: 0.5em 1em;
+    background-color: darken(#f5f5f5, 50%);
+    
+    h1 {
+      margin-top: 0;
+      margin-bottom: 0.2em;
+      font-size: 2em;
+      font-weight: bold;
+    }
+
+    ul#navigation {
+      li {
+        float: right;
+        font-weight: bold;
+        display: inline;
+        margin-top: 0.5em;
+        margin-left: 1em;
+
+        a {
+          color: black;
+          text-decoration: none;
+        }
+      }
+    }
+  }
+
+  section#content {
+    padding: 0.5em 1em;
+
+    h1 {
+      font-size: 1.5em;
+      margin-bottom: 0.5em;
+    }
+    
+    h2 {
+      font-size: 1.3em;
+      margin-bottom: 0.5em;
+      margin-top: 1em;
+    }
+
+    p {
+      line-height: 1.4em;
+      margin: 0.5em 0;
+    }
+
+    ul {
+      margin-top: 1em;
+      margin-left: 1.2em;
+      list-style: disc;
+      
+      li {
+        margin-bottom: 0.5em;
+      }
+    }
+    
+    ul#locales {
+      margin-top: 0;
+      margin-bottom: 1em;
+      margin-left: 0;
+      padding-left: 0;
+      font-size: 1.1em;
+      
+      &:before {
+        content: "Language:";
+        font-weight: bold;
+      }
+
+      li {
+        display: inline;
+      }
+    }
+
+    label {
+      font-weight: bold;
+    }
+
+    p.api_key {
+      text-align: center;
+      font-size: 1.5em;
+      font-weight: bold;
+    }
+    
+    code {
+      background-color: #333;
+      border: 2px solid #999;
+      color: white;
+      display: block;
+      font-family: monospace;
+      white-space: pre;
+      padding: 0.5em;
+      margin-top: 0.5em;
+      margin-bottom: 0.5em;
+    }
+
+    form {
+      .field {
+        margin-bottom: 0.5em;
+        
+        label {
+          width: 10em;
+          display: block;
+          float: left;
+        }
+
+        input[type="text"] {
+          min-width: 30em;
+        }
+
+        input[type="submit"] {
+          margin-left: 15em;
+        }
+      }
+    }
+
+    dl {
+      margin-bottom: 0.5em;
+      
+      dt {
+        font-weight: bold;
+        background-position: top left;
+        background-repeat: no-repeat;
+        padding-left: 20px;
+        
+        &.state-translated {
+          background-image: url("/images/translated.png");
+        }
+        
+        &.state-untranslated {
+          background-image: url("/images/untranslated.png");
+        }
+        
+        &.state-stale {
+          background-image: url("/images/stale.png");
+        }
+      }
+
+      dd {
+        margin-top: 0.2em;
+        margin-bottom: 0.5em;
+
+        textarea {
+          font-size: 1em;
+          font-family: "Georgia", serif;
+          padding: 0.3em;
+          width: 100%;
+        }
+
+        input[type="submit"] {
+          display: block;
+          font-size: 1em;
+        }
+
+        p.empty {
+          color: #999;
+        }
+      }
+    }
+  }
+
+  footer {
+    padding: 0.5em 1em;
+    text-align: right;
+  }
+}

data/views/users.haml

@@ -0,0 +1,29 @@
+%h1 User Management
+%p Listed below are the currently available users. You can only create users from here. To change their details, you'll have to get dirty in the console.
+
+%ul
+  - @users.each do |user|
+    %li
+      = user["name"]
+      = "(Superuser)" if user["superuser"]
+
+%h2 Create a User
+%form{ method: "post" }
+  %div.field
+    %label{ for: "name" } Name
+    %input{ type: "text", id: "name", name: "user[name]" }
+
+  %div.field
+    %label{ for: "username" } Username
+    %input{ type: "text", id: "username", name: "user[username]" }
+
+  %div.field
+    %label{ for: "password" } Password
+    %input{ type: "text", id: "password", name: "user[password]" }
+
+  %div.field
+    %label{ for: "superuser" } Superuser
+    %input{ type: "checkbox", id: "superuser", name: "user[superuser]", value: "true" }
+      
+  %div.field
+    %input{ type: "submit", value: "Create User" }

data/watchr.rb

@@ -0,0 +1,8 @@
+def restart_and_spec
+  system("powder restart")
+  system("bundle exec rspec spec")
+end
+
+watch( 'lib/.*\.rb' ) { |md| restart_and_spec }
+watch( 'views/.*') { |md| restart_and_spec }
+watch( 'spec/.*\.rb' ) { |md| system("bundle exec rspec spec") }

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification 
+name: TextTractor
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jon Wood
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-31 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sass
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: redis
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: redis-namespace
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id010
+description: TextTractor provides a web interface so that your clients can edit their copy, while you get on with more interesting things.
+email: 
+- jon@blankpad.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- assets/images/blankpad.png
+- assets/images/stale.png
+- assets/images/translated.png
+- assets/images/untranslated.png
+- assets/js/application.js
+- assets/js/jquery.js
+- assets/js/jquery.pjax.js
+- config.ru
+- lib/text_tractor.rb
+- lib/text_tractor/api_server.rb
+- lib/text_tractor/base.rb
+- lib/text_tractor/config.rb
+- lib/text_tractor/phrase.rb
+- lib/text_tractor/projects.rb
+- lib/text_tractor/ui_server.rb
+- lib/text_tractor/users.rb
+- lib/text_tractor/users_spec.rb
+- lib/text_tractor/version.rb
+- spec/api_server_spec.rb
+- spec/config_spec.rb
+- spec/phrase_spec.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb
+- spec/ui_server/authentication_spec.rb
+- spec/ui_server/project_management_spec.rb
+- spec/ui_server/project_viewing_spec.rb
+- spec/ui_server_spec.rb
+- spec/users_spec.rb
+- text_tractor.gemspec
+- views/blurbs/_blurb.haml
+- views/blurbs/edit.haml
+- views/blurbs/value.haml
+- views/index.haml
+- views/layout.haml
+- views/projects/getting_started.haml
+- views/projects/new.haml
+- views/projects/show.haml
+- views/styles.scss
+- views/users.haml
+- watchr.rb
+has_rdoc: true
+homepage: https://github.com/jellybob/text_tractor
+licenses: []
+
+post_install_message: If you're updating from 0.0.1 then you need to run TextTractor::Projects.update_datastore. See https://github.com/jellybob/text_tractor/wiki/Updating-Your-Datastore for details.
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1027683455972089235
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1027683455972089235
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: An implementation of the server side for a certain web service.
+test_files: 
+- spec/api_server_spec.rb
+- spec/config_spec.rb
+- spec/phrase_spec.rb
+- spec/project_spec.rb
+- spec/spec_helper.rb
+- spec/ui_server/authentication_spec.rb
+- spec/ui_server/project_management_spec.rb
+- spec/ui_server/project_viewing_spec.rb
+- spec/ui_server_spec.rb
+- spec/users_spec.rb