rapp 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41d0cf6c0f28404a0ff147a8410d0839fa829be2
-  data.tar.gz: 19000ad06894dcf3cf151f285e1db8faad7730bf
+  metadata.gz: 5760f2902c04d2f3457c56168c00b37f5f94c9d5
+  data.tar.gz: ab6132b2099f0f6f1d854d965766bbe5a14ff429
 SHA512:
-  metadata.gz: f75920e664cf117ad3e6ac442321e09820f41ad79b03179f4b0c1e59b1944dc76c2db74751b5e013ae3d17a3b69b84def24b67169dbfed3756d0a093f8191d2e
-  data.tar.gz: b8b6533125946fda5d95d00c9ee83e46c7f8680c0beed694f18532768de33fa3c4b7ab550dd4dd7a663db84e415865687763862d2ec963dc2f4b93aa3dc7e482
+  metadata.gz: e4f54bfd0662b4f6b935a527fcf3922b4ba44866317ef1f457b9a3688cbc73a2ef6c932c700d69636b7231000228e469bb3fa38542298a650e634d8c63a6128f
+  data.tar.gz: 86c326f983fe0ccbb7460d0f94af8f2ea6dc8ed59585a4944c41d47f6b4b48a8d08368b6009dc50556430291187727b1eb41f42b1ee5505824d80252f397f75a

data/README.md

@@ -2,6 +2,10 @@
 
 Rapp - The Ruby App Scaffolder
 
+## Note
+
+Prior to this incarnation, there was an older, similar gem named Rapp which was abandoned. I have obtained the authors permission both for use of the name, as well as for use of the project on Ruby Gems.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,11 +26,11 @@ Or install it yourself as:
 
 Using Rapp is incredibly simple. It's designed to work like familiar scaffolders / builders in the ruby community (think `rails new`).
 
-Currently, Rapp is in early development, and additional features are forthcoming. There is a Roadmap at the bottom of the Readme to highlight some of the work I feel is important to prioritize before a full v1 release. In addition to features, this includes the internal organization of the code as well, as the current state is more prototypical than it is final release quality.
+Currently, Rapp is in early development, and additional features are forthcoming. There is a Roadmap at the bottom of the Readme to highlight some of the work I feel is important to prioritize before a full v1 release. In addition to features, this includes the internal organization of the code as well.
 
 ### Ethos
 
-Rapp is not a framework for running an app or building an app from pieces-parts. In the future, there may be additional helpers to configure very common components in the ruby community, but the overall goal is to hand you a working application with a few common niceties, then get out of your way. Once you've generated the Rapp, the project is yours to do with as you see fit - the gem itself is not a dependencty of the app you create.
+Rapp is not a framework for running an app. In the future, there may be additional helpers to configure very common components in the ruby community, but the overall goal is to hand you a working application with a few common niceties, then get out of your way. Once you've generated the Rapp, the project is yours to do with as you see fit - the gem itself is not a dependency of the app you create.
 
 Rapps are shells to house your app, in a familiar layout, to prevent you from having to write the same boring boilerplate time and time again.
 
@@ -117,12 +121,21 @@ Mostly reserved for future use, this is where both Rapp specific specs to ensure
 
 Currently, Rapp comes with 1 predefined rake task, which is "console". This will boot up irb while loading your {app_name}.rb, which will load the rest of your app. This is aliased to "c" for convenience.
 
+### Specs
+
+Optionally you can generate specs for your app to test the underpinnings of what Rapp has created. You can do this by specifying the ```--specs``` or ```-s``` flags on the command line.
+
+These specs aim to not be in the way of you writing your own specs, and so the spec_helper is sparse, and the generated specs attempt to not include a test for {app_name}, but rather {app_name}_base, so that you can do any {app_name} specific testing in that file yourself.
+
+Mainly, these are here to help you make changes to a Rapp project once it's been generated if you so need, being able to verify that the core behaviors still function.
+
 ## Roadmap
 
 At the moment, this gem serves to fit a need that I found myself having and figured others might be as well. To that end, my main goals are to provide a simple, stable core ruby app intended to be run as a simple cli program, daemonized process, or otherwise. Currently, my primary roadmap for development is:
 
-1. Generate specs for the users application
-2. Test ease of use integrating Chore / Sidekiq like job systems
+1. Generate increased / improved specs for the users application
+2. General code cleanup. Much of the code is prototypical and is not as DRY as it could be (ex: the builder class)
+3. Test ease of use integrating Chore / Sidekiq like job systems
 
 ## Contributing
 
@@ -131,3 +144,7 @@ At the moment, this gem serves to fit a need that I found myself having and figu
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+# Contact
+
+Comments? Criticisms? Concerns? Open an issue on Github, or simply tweet at me. I'm @StabbyCutyou on Twitter.

data/lib/rapp/builder.rb

@@ -1,6 +1,7 @@
 require 'fileutils'
 require 'erb'
 require 'ostruct'
+require 'rapp/version'
 
 module Rapp
   DirectoryStructure = [
@@ -14,13 +15,17 @@ module Rapp
     "config/initializers",
     "lib",
     "lib/tasks",
-    "spec"
+  ]
+
+  SpecStructure = [
+    "spec",
+    "spec/app_name_base"
   ]
   class Builder
     class << self
       def new_app(opts={})
         # Get name
-        raise ArgumentError.new("You must provide a name") unless app_name = opts.delete(:name)
+        raise ArgumentError.new("You must provide a name") unless app_name = opts[:name]
         # Check if folder exists
         root_dir = "#{`pwd`.strip}/#{app_name}"
         raise ArgumentError.new("Directory #{root_dir} already exists") if File.directory?(root_dir) 
@@ -34,11 +39,17 @@ module Rapp
         end
         
         # For each template, render it, place it in the folder structure it corresponds to
-        template_root = File.join(File.dirname(__FILE__), 'templates')
         
         # Construct the data object
-        template_binding = OpenStruct.new({:name=>app_name, :class_name=>classify(app_name)})
-        Dir["#{template_root}/**/*"].reject { |p| File.directory? p }.each do |template|
+        template_binding = OpenStruct.new(
+          { :name=>app_name, 
+            :class_name=>classify(app_name),
+            :rapp_version=>Rapp::VERSION
+          })
+
+        # Skip spec dirs unless they said they wanted it
+        # My intention here is to use "or" specifically, because it does not short-circuit. The second check is very important
+        Dir["#{template_root}/**/*"].reject { |p| puts "#{p} -#{p.include?('spec')}"; File.directory? p or p.include?('spec') }.each do |template|
           template_data = File.read(template)
           relative_name = template.split("templates/")[1][0..-5]
           # Hack to make the entry point ruby file share the same name as the app
@@ -50,13 +61,55 @@ module Rapp
           File.write("#{root_dir}/#{relative_name}", result)
         end
 
+        # If set on the cli, build the spec stuff
+        add_specs(root_dir, opts) if opts[:specs]
+
         puts "Finished creating #{app_name}"
         puts "#{`find ./#{app_name}`}"
       end
 
+      def add_specs(root_dir, options)
+        app_name = options[:name]
+        #add rspec to the gemfile
+        open("#{root_dir}/Gemfile", 'a') do |f|
+          f.puts 'gem "rspec", "~>3.1.0"'
+        end
+
+        # Create the directory structrue
+        SpecStructure.each do |dir|
+          puts "dir is #{dir}"
+          name = dir.gsub!('app_name', app_name) if dir.include?("app_name")
+          puts "name is #{name}"
+          dir_name = "#{root_dir}/#{name}"
+          #puts "dirname #{dir_name}"
+          FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
+        end
+
+        # Construct the data object
+        template_binding = OpenStruct.new(
+          { :name=>app_name, 
+            :class_name=>classify(app_name),
+            :rapp_version=>Rapp::VERSION
+          })
+
+        # Get all the spec templates
+        Dir["#{template_root}/spec/**/*"].reject {|p| File.directory? p }.each do |template|
+          template_data = File.read(template)
+          relative_name = template.split("templates/")[1][0..-5]
+          relative_name = relative_name.gsub!('app_name', app_name) if relative_name.include?("app_name")
+          puts "template #{template} rel path #{relative_name}"
+          result = ERB.new(template_data).result(template_binding.instance_eval {binding})
+          File.write("#{root_dir}/#{relative_name}", result)
+        end
+      end
+
       def classify(string)
         string.gsub(/(?<=_|^)(\w)/){$1.upcase}.gsub(/(?:_)(\w)/,'\1')
       end
+
+      def template_root
+        File.join(File.dirname(__FILE__), 'templates')
+      end 
     end
   end
 end

data/lib/rapp/cli.rb

@@ -7,6 +7,10 @@ module Rapp
 
         OptionParser.new do |opts|
           opts.banner = "Usage: rapp [app_name]"
+
+          opts.on("-s", "--specs", "Generate basic validation specs for the app you build") do
+            options[:specs] = true
+          end
         end.parse!
 
         options

data/lib/rapp/templates/app_base.rb.erb

@@ -2,6 +2,8 @@ require 'env'
 
 module <%= class_name %>Base
   
+  RAPP_VERSION="<%= rapp_version %>"
+
   def self.included(base) #:nodoc:
     base.extend(ClassMethods)
     <%= class_name%>Base.boot!

data/lib/rapp/templates/spec/app_name_base/env_spec.rb.erb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe <%= class_name %>::Env do
+  context 'when in production mode' do
+    subject {<%= class_name%>::Env.new('production') }
+
+    context '#production?' do
+      it 'should be true' do
+        expect(subject.production?).to eq(true)
+      end
+    end
+
+    context '#development?' do
+      it 'should be false' do
+        expect(subject.development?).to eq(false)
+      end
+    end
+  end
+
+  context 'when in development mode' do
+    subject {<%= class_name%>::Env.new('development') }
+
+    context '#production?' do
+      it 'should be true' do
+        expect(subject.production?).to eq(false)
+      end
+    end
+
+    context '#development?' do
+      it 'should be false' do
+        expect(subject.development?).to eq(true)
+      end
+    end
+  end
+end

data/lib/rapp/templates/spec/app_name_base_spec.rb.erb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe <%= class_name %>Base do
+  context '#RAPP_VERSION' do
+    it 'should be <%= rapp_version%>' do
+      expect(subject::RAPP_VERSION).to eq("<%=rapp_version %>")
+    end
+  end
+
+  context '#env' do
+    before :each do
+      # clear this before each run, restore to it's original value after. Kind of hacky, but dont wanna lose the app_env the user may have set
+      @former_app_env = ENV['APP_ENV']
+      ENV['APP_ENV'] = nil
+
+      # We also need to reset the env in the <%=class_name%> each time, so it tries to create a new Env object and picks up the new ENV value. Also kind of hacky
+      <%= class_name%>.instance_variable_set('@env',nil)
+
+      # These specs are made slightly more hacky to set up because I purposfully chose to have the Env be set once, and not make it automatically detect changes to APP_ENV. When the app boots up, it should detect it's environment once, and thats it.
+    end
+
+    after :each do
+      ENV['APP_ENV'] = @former_app_env
+    end
+
+    context 'when no environment is specified' do
+      it 'defaults to development' do
+        expect(<%= class_name%>.env.to_s).to eq('development')
+      end
+    end
+
+    it 'should get the configured environment from ENV' do
+      ENV['APP_ENV'] = 'production'
+      expect(<%= class_name%>.env.to_s).to eq('production')
+    end
+  end
+end

data/lib/rapp/templates/spec/spec_helper.rb.erb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+
+require 'rspec'
+require '<%= app_name %>'
+
+RSpec.configure do |config|
+
+end

data/lib/rapp/version.rb

@@ -1,3 +1,3 @@
 module Rapp
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/rapp.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rapp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - StabbyCutyou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-17 00:00:00.000000000 Z
+date: 2015-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 description: rapp helps you build native ruby apps with a familiar structure and a
   handful of familiar conventions.
 email:
@@ -65,6 +79,9 @@ files:
 - lib/rapp/templates/config/environments/test.rb.erb
 - lib/rapp/templates/env.rb.erb
 - lib/rapp/templates/lib/tasks/console.rake.erb
+- lib/rapp/templates/spec/app_name_base/env_spec.rb.erb
+- lib/rapp/templates/spec/app_name_base_spec.rb.erb
+- lib/rapp/templates/spec/spec_helper.rb.erb
 - lib/rapp/version.rb
 - rapp.gemspec
 homepage: https://github.com/StabbyCutyou/rapp