framework 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba75921072b35b2f243539a2c8875c6eaabccd39
-  data.tar.gz: 3091bbda391dcabdc6e04588d40b25cc12ef07e9
+  metadata.gz: 17ea2a57355b495eff2e3798ed32103017673a3a
+  data.tar.gz: 01739b92621f21c8122b34a5759e5f811615842f
 SHA512:
-  metadata.gz: e1c690e3bfed331f6dd5206df9a3d6e1f5ff1f7ce7ab3394d1af9fe2cc0d71e82d9e9c3cc90adf39786467e8e2452e1520abd44947928b47aa00eb30bdb19458
-  data.tar.gz: f09cafc01abb92a531662ae3b6dbb245f9c72f1e721cb9d76e4f820119ff4daf9354e63d005d68423c0f3a148f028941b8a79398c0bb04370c49b5b991a2f033
+  metadata.gz: 9fe435f8328873b76556566d8fadd6ea49911dc07763f95fcc63124c0b8b8ad39a2bda4e9af9e745079226c83a3163653f30bc34ddb184d1240b2181f0f0e1f6
+  data.tar.gz: 0a7d80ceeb19c004f9823fae991f36ac0d3c2d9a212d24fcb62b4fca3a229b2dbcc70ad3dc7ad956e162b4f99737bf9bf4ee33e9adf049ea9bcaa77e88dd19f9

data/README.md

@@ -0,0 +1,110 @@
+Ruby Framework
+=========
+
+[![Gem Version](https://badge.fury.io/rb/framework.svg)](http://badge.fury.io/rb/framework)
+
+Framework to build Ruby applications for all your needs. Inspired by Rails, but clear and clean from any web-related backend.
+
+### Features
+
+- Easy configuration to work with multiple databases
+- ActiveRecord interface
+- Customizable structure
+- YAML configuration
+- Appication generators
+- Useful console mode
+- ... Find more
+
+### When to use
+
+- Obviously, you need a framework :)
+- You need to quickly start a project from scratch 
+- You want to have your backend code to stay separate from any large frameworks (like Rails)
+- You want to build some "worker" application running your business logic with no interface
+- Setting up an interview? Use Framework!
+- Wanna build web application? You can easily integrate your code into any web framework (Rack, Rails etc) (see below)
+- You don't want to learn a new framework, you are the one who knows only Rails :)
+- You want to test something quickly and you don't want to waste your time setting new environment up
+
+### Quick start
+
+1) Install Framework at the command prompt if you haven't yet:
+
+```shell
+gem install framework
+```
+
+2) Create a new application:
+
+```shell
+framework new myapp
+```
+
+### Run console to play
+
+```shell
+rake console
+```
+
+![screen shot 2014-11-28 at 17 14 48](https://cloud.githubusercontent.com/assets/370635/5226522/dcfbdc42-7719-11e4-9af9-602d1e68e0fa.png)
+
+### Structure
+
+Pretty similar to Rails (just a sample):
+
+```
+.
+|____app
+| |____models
+| | |____concerns
+| | | |____.keep
+| | |____task.rb
+| | |____user.rb
+| |____tasks
+| | |____hello.rake
+|____config
+| |____application.yml
+| |____databases.yml
+| |____environment.rb
+| |____initializers
+| | |____time_zone.rb
+|____db
+| |____migrations
+| | |____.keep
+| | |____20141128085924_create_tasks.rb
+| | |____20141128090211_create_users.rb
+|____Gemfile
+|____Gemfile.lock
+|____lib
+| |____.keep
+|____Rakefile
+|____README.md
+```
+
+### Configuration
+
+Configurations are stored in `config/application.yml`. Note, that as opposed to Rails, even initializers and models are listed as custom paths in `autoload_paths` section. This gives you a flexibility to explicitly say which paths and what exactly used in your app. Don't need no initializers? Don't list them in autoload paths. Order matters.
+
+```yaml
+development: &common
+  enable_logging: yes
+  autoload_paths:
+    - config/initializers
+    - app/models
+  default_timezone: 'Pacific Time (US & Canada)'
+
+test:
+  <<: *common
+  enable_logging: no
+
+staging:
+  <<: *common
+
+production:
+  <<: *common
+  enable_logging: no
+```
+
+### More docu and updates coming soon
+
+I encourage you to contribute! :)

data/lib/framework/application.rb

@@ -36,15 +36,38 @@ module Framework
 
     def create_database!(name = nil)
       name ||= 'default'
-      establish_postgres_connection(name)
-      ActiveRecord::Base.connection.create_database(database_config[name][env]['database'])
-      puts "The database #{database_config[name][env]['database']} has been successfully created"
+      cfg = database_config[name][env]
+
+      case cfg['adapter']
+      when 'postgresql'
+        establish_postgres_connection(name)
+        ActiveRecord::Base.connection.create_database(cfg['database'])
+      when 'sqlite3'
+        raise 'Database already exists' if File.exist?(cfg['database'])
+        establish_database_connection
+      else
+        raise "Unknown adapter '#{cfg['adapter']}'"
+      end
+
+      puts "The database #{cfg['database']} has been successfully created"
     end
 
     def drop_database!(name = nil)
       name ||= 'default'
-      establish_postgres_connection(name)
-      ActiveRecord::Base.connection.drop_database(database_config[name][env]['database'])
+      cfg = database_config[name][env]
+
+      case cfg['adapter']
+      when 'postgresql'
+        establish_postgres_connection(name)
+        ActiveRecord::Base.connection.drop_database(cfg['database'])
+      when 'sqlite3'
+        require 'pathname'
+        path = Pathname.new(cfg['database']).to_s
+        FileUtils.rm(path) if File.exist?(path)
+      else
+        raise "Unknown adapter '#{cfg['adapter']}'"
+      end
+
       puts "The database #{database_config[name][env]['database']} has been successfully dropped"
     end
 

data/lib/framework/cli.rb

@@ -1,181 +1,12 @@
-require 'active_support/core_ext/string/inflections'
-require 'active_support/core_ext/string/strip'
 require 'thor'
 
-require 'framework/version'
+require 'framework'
+require 'framework/generators/multi_generator'
+require 'framework/generators/application_generator'
 
 module Framework
-  class AppGenerator < Thor::Group
-    include Thor::Actions
-
-    argument :name
-
-    def self.source_root
-      File.dirname(__FILE__)
-    end
-
-    def create_base_directories
-      empty_directory 'app/migrations'
-      create_file 'app/migrations/.keep'
-
-      empty_directory 'app/models'
-      empty_directory 'app/models/concerns'
-      create_file 'app/models/concerns/.keep'
-
-      empty_directory 'lib'
-      create_file 'lib/.keep'
-
-      empty_directory 'db'
-      empty_directory 'db/migrations'
-      create_file 'db/migrations/.keep'
-
-    end
-
-    def create_application_config
-      create_file 'config/application.yml' do
-        <<-CONFIG.strip_heredoc
-        development: &common
-          enable_logging: yes
-          autoload_paths:
-            - config/initializers
-            - app/models
-          default_timezone: 'Pacific Time (US & Canada)'
-
-        test:
-          <<: *common
-          enable_logging: no
-
-        staging:
-          <<: *common
-
-        production:
-          <<: *common
-          enable_logging: no
-        CONFIG
-      end
-    end
-
-    def create_database_config
-      db_name = name.underscore
-
-      create_file 'config/databases.yml' do
-        <<-CONFIG.strip_heredoc
-        # Defult database is used by default.
-        # Any models locating at app/models root directory will point to this database by default.
-        default:
-          development: &common
-            adapter: postgresql
-            username:
-            password:
-            database: #{db_name}_development
-            min_messages: WARNING
-            reconnect: true
-            pool: 5
-            encoding: unicode
-            host: localhost
-
-          test:
-            <<: *common
-            database: #{db_name}_test
-
-          production:
-            <<: *common
-            database: #{db_name}_production
-
-        # Custom one. Models located at app/models/second_one path will point to this database by default.
-        second_one:
-          development: &common
-            adapter: postgresql
-            username:
-            password:
-            database: second_sample_development
-            min_messages: WARNING
-            reconnect: true
-            pool: 5
-            encoding: unicode
-            host: localhost
-
-          test:
-            <<: *common
-            database: second_sample_test
-
-          production:
-            <<: *common
-            database: second_sample_production
-        CONFIG
-      end
-    end
-
-    def create_environment
-      create_file 'config/environment.rb' do
-        <<-CONFIG.strip_heredoc
-        # Set up gems listed in the Gemfile.
-        ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-        require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
-
-        require 'framework'
-
-        Bundler.require(:default, Framework.env)
-
-        Framework::Application.new do |app|
-          app.init!
-        end
-        CONFIG
-      end
-    end
-
-    def create_gemfile
-      create_file 'Gemfile' do
-        <<-CONFIG.strip_heredoc
-          source 'https://rubygems.org'
-
-          gem 'framework', '#{Framework::VERSION}'
-          gem 'pg'
-        CONFIG
-      end
-    end
-
-    def create_rakefile
-      create_file 'Rakefile' do
-        <<-CONFIG.strip_heredoc
-        # Add your own tasks in files placed in lib/tasks ending in .rake,
-        # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-        require 'framework'
-        require 'framework/rake'
-
-        Dir["\#{Dir.pwd}/app/tasks/**/*.rake"].each(&method(:load))
-        CONFIG
-      end
-    end
-
-    def create_sample_tasks
-      empty_directory 'app/tasks'
-      create_file 'app/tasks/hello.rake' do
-        <<-RAKE.strip_heredoc
-        task hello: :environment do
-          Framework::Logger.disappointment("Hello from: Framework v#{Framework::VERSION}")
-        end
-        RAKE
-      end
-    end
-
-    def create_sample_initializers
-      empty_directory 'config/initializers'
-      create_file 'config/initializers/time_zone.rb' do
-        <<-CONFIG.strip_heredoc
-          # Sample usage of application config
-          Time.zone = Framework.app.config['default_timezone']
-        CONFIG
-      end
-    end
-
-    def create_readme
-      create_file 'README.md', "This app utilizes Framework v#{Framework::VERSION} and rocks MIT license."
-    end
-  end
-
   class Cli < Thor
-    register(Framework::AppGenerator, 'new', 'new APP_NAME', 'Generates new application')
+    register(Framework::ApplicationGenerator, 'new', 'new APP_NAME', 'Generates new application')
+    register(Framework::MultiGenerator, 'generate', 'generate <migration>', 'Generates the thing you want')
   end
 end

data/lib/framework/generators/application_generator.rb

@@ -0,0 +1,170 @@
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/string/strip'
+
+module Framework
+  class ApplicationGenerator < Thor::Group
+    include Thor::Actions
+
+    argument :name
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    def create_base_directories
+      empty_directory 'app/models'
+      empty_directory 'app/models/concerns'
+      create_file 'app/models/concerns/.keep'
+
+      empty_directory 'lib'
+      create_file 'lib/.keep'
+
+      empty_directory 'db'
+      empty_directory 'db/migrations'
+      create_file 'db/migrations/.keep'
+    end
+
+    def create_application_config
+      create_file 'config/application.yml' do
+        <<-CONFIG.strip_heredoc
+        development: &common
+          enable_logging: yes
+          autoload_paths:
+            - config/initializers
+            - app/models
+          default_timezone: 'Pacific Time (US & Canada)'
+
+        test:
+          <<: *common
+          enable_logging: no
+
+        staging:
+          <<: *common
+
+        production:
+          <<: *common
+          enable_logging: no
+        CONFIG
+      end
+    end
+
+    def create_database_config
+      db_name = name.underscore
+
+      create_file 'config/databases.yml' do
+        <<-CONFIG.strip_heredoc
+        # Defult database is used by default.
+        # Any models locating at app/models root directory will point to this database by default.
+        default:
+          development: &common
+            adapter: postgresql
+            username:
+            password:
+            database: #{db_name}_development
+            min_messages: WARNING
+            reconnect: true
+            pool: 5
+            encoding: unicode
+            host: localhost
+
+          test:
+            <<: *common
+            database: #{db_name}_test
+
+          production:
+            <<: *common
+            database: #{db_name}_production
+
+        # Custom one. Models located at app/models/second_one path will point to this database by default.
+        second_one:
+          development: &common
+            adapter: postgresql
+            username:
+            password:
+            database: second_sample_development
+            min_messages: WARNING
+            reconnect: true
+            pool: 5
+            encoding: unicode
+            host: localhost
+
+          test:
+            <<: *common
+            database: second_sample_test
+
+          production:
+            <<: *common
+            database: second_sample_production
+        CONFIG
+      end
+    end
+
+    def create_environment
+      create_file 'config/environment.rb' do
+        <<-CONFIG.strip_heredoc
+        # Set up gems listed in the Gemfile.
+        ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+        require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+
+        require 'framework'
+
+        Bundler.require(:default, Framework.env)
+
+        Framework::Application.new do |app|
+          app.init!
+        end
+        CONFIG
+      end
+    end
+
+    def create_gemfile
+      create_file 'Gemfile' do
+        <<-CONFIG.strip_heredoc
+          source 'https://rubygems.org'
+
+          gem 'framework', '#{Framework::VERSION}'
+          gem 'pg'
+        CONFIG
+      end
+    end
+
+    def create_rakefile
+      create_file 'Rakefile' do
+        <<-CONFIG.strip_heredoc
+        # Add your own tasks in files placed in lib/tasks ending in .rake,
+        # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+        require 'framework'
+        require 'framework/rake'
+
+        Dir["\#{Dir.pwd}/app/tasks/**/*.rake"].each(&method(:load))
+        CONFIG
+      end
+    end
+
+    def create_sample_tasks
+      empty_directory 'app/tasks'
+      create_file 'app/tasks/hello.rake' do
+        <<-RAKE.strip_heredoc
+        task hello: :environment do
+          Framework::Logger.disappointment("Hello from: Framework v#{Framework::VERSION}")
+        end
+        RAKE
+      end
+    end
+
+    def create_sample_initializers
+      empty_directory 'config/initializers'
+      create_file 'config/initializers/time_zone.rb' do
+        <<-CONFIG.strip_heredoc
+          # Sample usage of application config
+          Time.zone = Framework.app.config['default_timezone']
+        CONFIG
+      end
+    end
+
+    def create_readme
+      create_file 'README.md', "This app utilizes Framework v#{Framework::VERSION} and rocks MIT license."
+    end
+  end
+end

data/lib/framework/generators/migration_generator.rb

@@ -1,8 +1,11 @@
+require 'framework/migration'
 require 'erb'
 
 module Framework
   class MigrationGenerator
 
+    # @param [String] db_name
+    # @param [String] migration_name
     def initialize(db_name: db_name, migration_name: name)
       @db_name = db_name.underscore
       @migration_name = migration_name.underscore
@@ -16,7 +19,7 @@ module Framework
       migration_file << ERB.new(template).result(context)
       migration_file.close
 
-      Framework.app.hint "Generated migration: #@path"
+      p "Generated migration: #@path"
     end
 
     def templates_path
@@ -43,7 +46,7 @@ module Framework
       def load_migrations
         Dir["./db/migrations/**/*.rb"].each(&method(:load))
       rescue
-        raise "An error was occurred"
+        raise 'An error was occurred'
       end
 
       def validate!

data/lib/framework/generators/multi_generator.rb

@@ -0,0 +1,22 @@
+require 'framework/generators/migration_generator'
+
+module Framework
+  class MultiGenerator < Thor::Group
+    argument :target_type
+    argument :target_name
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    def generate
+      case target_type
+      when 'migration'
+        Framework::MigrationGenerator.new(db_name: (ENV['DB_NAME'] || 'default'), migration_name: target_name).generate
+      else
+        raise "Don't know how to build task 'generate #{target_type}'"
+      end
+    end
+  end
+end
+

data/lib/framework/tasks/console.rake

@@ -2,7 +2,7 @@ desc "Runs irb console and initializes the application"
 task :console, :env do |_, args|
   require 'irb'
 
-  unless env = ENV['ANALYTICS_ENV']
+  unless env = ENV['FRAMEWORK_ENV']
     env = args[:env] || Framework::DEFAULT_ENV
   end
 

data/lib/framework/tasks/engine/environment.rake

@@ -1,3 +1,3 @@
 task :environment do
-  Framework::Application.new(ENV['ANALYTICS_ENV'] || 'development').init!
+  Framework::Application.new.init!
 end

data/lib/framework/version.rb

@@ -1,3 +1,3 @@
 module Framework
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

data/lib/framework.rb

@@ -25,10 +25,3 @@ module Framework
   end
 end
 
-begin
-  Bundler.require(:default, Framework.env)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: framework
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sergei Nikolaevich Zinin
@@ -158,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - Rakefile
 - bin/framework
 - lib/framework.rb
@@ -165,7 +166,9 @@ files:
 - lib/framework/cli.rb
 - lib/framework/db_listener.rb
 - lib/framework/extensions/active_record/base_extension.rb
+- lib/framework/generators/application_generator.rb
 - lib/framework/generators/migration_generator.rb
+- lib/framework/generators/multi_generator.rb
 - lib/framework/logger.rb
 - lib/framework/migration.rb
 - lib/framework/rake.rb