foshow 0.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in foshow.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Micah Cooper
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Foshow
+
+Foshow allows you to display the application code in your rails application.
+
+I use it for presentations where I don't want to make slides and or switch back and forth between my application and my code. This allows me to have a working app, and display the code it took to create it, right next to it. It can be very usefull for introducing new ideas to people.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'foshow'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foshow
+
+## Usage
+
+###Default - Rails conventions
+This gem only works with rails apps and assumes you are following rails basing MVC naming conventions.
+For example, a model named "user" has a controller named "app/controllers/users_controller.rb" and a view directory called "app/views/users/"
+
+All you have to do is add this to your application layout ('apps/views/layouts/application.html.erb').
+
+    Foshow.render(self)
+
+This, by default, displays the code for the model, view, and controller of the resource you're viewing.
+
+###Configurating beyond the defaults
+If you want to display more code for a page, do it here: 'config/initializers/foshow.rb'
+
+To display more code for a resource(page) configure Foshow with a Hash.
+
+The keys of this hash can be: models, views, controllers, javascripts, helpers
+
+The values of these keys can be a Hash or an Array. It's kinda like your routes file. Observe:
+
+	#Use a Hash to specify what controller#action will display the files given.
+	#Use just an Array to make the files display on all controller#actions.
+
+	Foshow.configure do
+		{
+			views: { 'controller#action_name' => ['app/views/controller/other_file_name.html.erb']}
+			javascripts: ['app/assets/javascripts/global.js']
+		}
+	end
+
+__note__: The file paths must always be in an array. They will not render otherwise
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,122 @@
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Time.now.strftime('%Y-%m-%d')
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+task RSpec::Core::RakeTask.new('spec')
+
+task :default => "spec"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/foshow.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.name              = 'foshow'
+  s.version           = '0.0.0'
+  s.date              = '2012-08-10'
+
+  s.summary       = %q{Show the code it took to make your rails app, in your rails app}
+  s.description   = %q{
+  Foshow provides a very simple interface that allows you to display your code in your application.
+  This can be very useful for presentations when you don't want to create slides or jump back and
+  forth between you code and your application.}
+
+  s.authors       = ["Micah Cooper"]
+  s.email         = ["mrmicahcooper@gmail.com"]
+  s.homepage      = "https://github.com/mrmicahcooper/foshow"
+
+  s.require_paths = %w[lib]
+
+  s.extra_rdoc_files = %w[README.md LICENSE.md]
+
+  s.add_dependency 'coderay'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry'
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE.md
+    README.md
+    Rakefile
+    foshow.gemspec
+    lib/foshow.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files    = s.files.grep(%r{^spec/})
+end

data/lib/foshow.rb

@@ -0,0 +1,119 @@
+require 'ostruct'
+require 'singleton'
+
+class Foshow
+
+  include Singleton
+
+  VERSION = "0.0.0"
+
+  attr_accessor :views, :renderer
+
+  def self.configure(&block)
+    yield instance.config
+  end
+
+  def self.render(renderer)
+    instance.renderer = renderer
+    instance.render
+  end
+
+  def config
+    @config ||= OpenStruct.new
+  end
+
+  def render
+    renderer.content_tag(:section, id: 'code_viewer') do
+      build_navigation + build_elements
+    end.html_safe
+  end
+
+  private
+
+  def show_keys
+    @show_keys ||= config.marshal_dump.keys | defaults.marshal_dump.keys
+  end
+
+  def build_navigation
+    renderer.content_tag(:nav) do
+      "".tap do |html_container|
+        show_keys.each do |name|
+          html_container << " #{renderer.link_to(name, '#', class: name)}"
+        end
+      end.html_safe
+    end
+  end
+
+
+  def defaults
+    @defaults ||= OpenStruct.new({
+      views: ["app/views/#{renderer.controller_name}/#{renderer.action_name}.html.haml"],
+      controllers: ["app/controllers/#{renderer.controller_name}_controller.rb"],
+      model: ["app/models/#{renderer.controller_name.singularize}.rb"],
+      all: []
+    })
+  end
+
+  def build_elements
+    "".tap do |html_container|
+      show_keys.each do |key|
+        html_container << renderer.content_tag(:div, class: "#{key.to_s}") { show_code(defaults.send(key) || []).html_safe }
+        html_container << renderer.content_tag(:div, class: "#{key.to_s}") { show_code(config_directories(key) || []).html_safe }
+      end
+    end.html_safe
+  end
+
+  def show_code(file_array, lang=:ruby)
+    files = file_array.flatten
+    "".tap do |html_string|
+      files.each do |file|
+        html_string << highlighted_code(file)
+      end
+    end
+  end
+
+  def config_directories(key)
+    pages = config.send(key) || []
+    a = pages.compact.map do |page|
+      if page.is_a?(Hash)
+        page["#{renderer.controller_name}##{renderer.action_name}"] || []
+      else
+        page
+      end
+    end
+  end
+
+  def highlighted_code(file)
+    CodeRay.scan(" \#// #{file}\n\n" + code_string(file), file_lang(file)).div
+  end
+
+  def code_string(file)
+    puts file
+    read_file(file)
+  end
+
+  def read_file(file)
+    begin
+      File.read(file)
+    rescue Errno::ENOENT
+      "not found"
+    end
+  end
+
+  def file_extension(file)
+    File.extname(file)[1..-1]
+  end
+
+  def supported_file_types
+    {
+      ruby: "rb",
+      javascript: "js",
+      haml: "haml"
+    }
+  end
+
+  def file_lang(file)
+    supported_file_types.invert[file_extension(file)]
+  end
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: foshow
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Micah Cooper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coderay
+  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: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: ! "\n  Foshow provides a very simple interface that allows you to display
+  your code in your application.\n  This can be very useful for presentations when
+  you don't want to create slides or jump back and\n  forth between you code and your
+  application."
+email:
+- mrmicahcooper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- foshow.gemspec
+- lib/foshow.rb
+homepage: https://github.com/mrmicahcooper/foshow
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 2
+summary: Show the code it took to make your rails app, in your rails app
+test_files: []